Orders with product claims

Request

Endpoint listing all ordered products with unfulfilled claims.

Endpoint supports Paging.

Security

shoptetAccessToken or shoptetPrivateApiToken

Query

includeClosedAndCancelledOrdersbooleandeprecated

Include orders in final state - such as closed and cancelled orders. Default false. DEPRECATED due to misleading name and actual irrelevance. To be removed in the future.

Example:includeClosedAndCancelledOrders=true

productCodestring

Filter order claims by product code

Example:productCode=DS53437473

orderCodestring

Filter order claims by order code

Example:orderCode=2017000066

itemsPerPageinteger

Returned items per page. Default value is 100. Max value is 250.

Example:itemsPerPage=110

pageinteger

Page number to return. Default value is 1.

Example:page=3

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders/claims?includeClosedAndCancelledOrders=true&productCode=DS53437473&orderCode=2017000066&itemsPerPage=110&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

dataobjectrequired

errorsArray of objects or null(Errors)required

metadataobject(Metadata)required

Response

{
  "data": {
    "orders": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}