search
System Status

Returns

A return represents the full or partial return of items in an order. Returns are always associated with an order and may optionally contain a refund.

hashtag
Returns a list of returns

get

Get all returns.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
endingBeforestringOptional

A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.

startingAfterstringOptional

A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

statestringOptional

Only return objects in the given state

orderIdstringOptional

The order to retrieve returns for.

skuIdstringOptional

The sku to retrieve returns for.

Responses
chevron-right
200

200 OK

application/json
hasMorebooleanOptional

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example: true
get
/returns

hashtag
Creates a return

post

Returns all or part of a previously created order.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
orderIdstringRequired

The unique identifier of the Order associated with the Return.

Example: ord_6645940010
reasonstring · max: 64Optional

The reason for the return.

Example: requested_by_customer
Responses
post
/returns

hashtag
Gets a return by ID

get

Retrieves the details of a return. Supply the unique identifier of the return.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Return ID

Responses
chevron-right
200

OK.

application/json
idstringRead-onlyOptional

The unique identifier of the return.

Example: ret_5823594809
createdTimestring · date-timeRead-onlyOptional

The time at which the return was created.

Example: {"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"nano":0,"year":2018,"monthValue":4,"dayOfMonth":25,"hour":20,"minute":36,"second":0,"dayOfWeek":"WEDNESDAY","dayOfYear":115,"month":"APRIL"}
updatedTimestring · date-timeRead-onlyOptional

The time at which the return was updated.

Example: {"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"nano":0,"year":2018,"monthValue":4,"dayOfMonth":25,"hour":20,"minute":36,"second":0,"dayOfWeek":"WEDNESDAY","dayOfYear":115,"month":"APRIL"}
orderIdstringRead-onlyOptional

The unique identifier of the order.

Example: ord_6645940010
currencystringOptional

A three-letter ISO currency code.

Example: USD
reasonstringOptional

The reason for the return.

Example: requested_by_customer
failureReasonstringOptional

An enumeration indicating the reason for the return failure, if known.

statestring · enumOptional

An enumeration indicating the state of the return.

Example: createdPossible values:
liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example: false
refundIdsstring[]Read-onlyOptional

The identifier of a refund issued for this return.

Example: 0848750667
get
/returns/{id}

hashtag
Updates an existing return

post

Updates an existing return.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Return ID

Body
statestring · enumOptional

Enumeration indicating the state of the return.

Example: acceptedPossible values:
Responses
chevron-right
200

200 OK

application/json
idstringRead-onlyOptional

The unique identifier of the return.

Example: ret_5823594809
createdTimestring · date-timeRead-onlyOptional

The time at which the return was created.

Example: {"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"nano":0,"year":2018,"monthValue":4,"dayOfMonth":25,"hour":20,"minute":36,"second":0,"dayOfWeek":"WEDNESDAY","dayOfYear":115,"month":"APRIL"}
updatedTimestring · date-timeRead-onlyOptional

The time at which the return was updated.

Example: {"offset":{"totalSeconds":0,"id":"Z","rules":{"fixedOffset":true,"transitions":[],"transitionRules":[]}},"nano":0,"year":2018,"monthValue":4,"dayOfMonth":25,"hour":20,"minute":36,"second":0,"dayOfWeek":"WEDNESDAY","dayOfYear":115,"month":"APRIL"}
orderIdstringRead-onlyOptional

The unique identifier of the order.

Example: ord_6645940010
currencystringOptional

A three-letter ISO currency code.

Example: USD
reasonstringOptional

The reason for the return.

Example: requested_by_customer
failureReasonstringOptional

An enumeration indicating the reason for the return failure, if known.

statestring · enumOptional

An enumeration indicating the state of the return.

Example: createdPossible values:
liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example: false
refundIdsstring[]Read-onlyOptional

The identifier of a refund issued for this return.

Example: 0848750667
post
/returns/{id}
PreviousReservationsNextSKUs

Last updated