return

return.list

Get list of return requests from store.

get/return.list.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/return.list.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Query parameters

startinteger

This parameter sets the number from which you want to get entities

countinteger

This parameter sets the entity amount that has to be retrieved. Max allowed count=250

page_cursorstring

Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)

order_idstring

Defines the order id

order_idsstring

Retrieves return requests specified by order ids

customer_idstring

Retrieves return requests specified by customer id

store_idstring

Store Id

statusstring

Defines status

return_typestring

Retrieves returns specified by return type

created_fromstring

Retrieve entities from their creation date

created_tostring

Retrieve entities to their creation date

modified_fromstring

Retrieve entities from their modification date

modified_tostring

Retrieve entities to their modification date

response_fieldsstring

Set this parameter to choose which entity fields to retrieve. Use comma-separated field names in curly braces, nested to match the response structure, e.g. {result{product{id,name}}}. The wildcard * returns every field at a level: {} gives the whole response, {result{product{}}} all product fields.

paramsstring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve

excludestring

Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to ignore. Works only if parameter params equal force_all

report_request_idstring

Report request id

disable_report_cacheboolean

Disable report cache for current request

Response

successful operation

return_codeinteger nullable
return_messagestring nullable
additional_fieldsobject nullable
custom_fieldsobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.