return.list
Get list of return requests from store.
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
This parameter sets the number from which you want to get entities
This parameter sets the entity amount that has to be retrieved. Max allowed count=250
Used to retrieve entities via cursor-based pagination (it can't be used with any other filtering parameter)
Defines the order id
Retrieves return requests specified by order ids
Retrieves return requests specified by customer id
Store Id
Defines status
Retrieves returns specified by return type
Retrieve entities from their creation date
Retrieve entities to their creation date
Retrieve entities from their modification date
Retrieve entities to their modification date
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.
Important! Parameter deprecated, use response_fields instead. Set this parameter in order to choose which entity fields you want to retrieve
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 id
Disable report cache for current request
Response
successful operation
Changes
No recorded changes to this operation across all 1 revision of this API.