Returns

You may find descriptions of endpoints for work with returned orders bellow.

Filter returns

post
Authorizations
x-api-keystringRequired
authorizationstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
pageinteger · min: 1Optional

Page number, can be used for pagination

Default: 1Example: 1
itemsinteger · min: 1 · max: 1000Optional

items per page

Default: 10Example: 30
Responses
chevron-right
200

Success response

application/json
statusCodenumberRequiredDefault: 200
messagestringRequired
post
/returns/filter

Get return

get
Authorizations
x-api-keystringRequired
authorizationstringRequired
Path parameters
eshopReturnIdstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Responses
chevron-right
200

Success response

application/json
statusCodenumberRequiredDefault: 200
messagestringRequired
get
/returns/{eshopReturnId}

Create return

post
Authorizations
x-api-keystringRequired
authorizationstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopReturnIdstringRequiredExample: eshopReturnId
eshopOrderIdstring · min: 1OptionalExample: eshopOrderId
notestringOptional
eshopNotestringOptional

Note from e-shop that is not shown to the customer

descriptionstring · min: 1OptionalExample: Wrong shoe size
shipperstring · min: 1OptionalExample: DHL
trackingNumberstring · min: 1OptionalExample: AB12345
shipperServiceCodestringOptionalExample: DHLEU
orderTypestring · enumRequiredExample: b2cPossible values:
Responses
chevron-right
200

Success response

application/json
statusCodenumberRequiredDefault: 200
messagestringRequired
post
/returns

Update return

put
Authorizations
x-api-keystringRequired
authorizationstringRequired
Path parameters
eshopReturnIdstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopReturnIdstringRequiredExample: eshopReturnId
eshopOrderIdstring · min: 1OptionalExample: eshopOrderId
notestringOptional
eshopNotestringOptional

Note from e-shop that is not shown to the customer

descriptionstring · min: 1OptionalExample: Wrong shoe size
shipperstring · min: 1OptionalExample: DHL
trackingNumberstring · min: 1OptionalExample: AB12345
shipperServiceCodestringOptionalExample: DHLEU
orderTypestring · enumRequiredExample: b2cPossible values:
canceledAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z
confirmedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z
receivedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z
statusstring · enumOptional

You can update only to canceled status, other statuses are not allowed. This field is optional.

Possible values:
Responses
chevron-right
200

Success response

application/json
statusCodenumberRequiredDefault: 200
messagestringRequired
put
/returns/{eshopReturnId}

Partially update return

patch
Authorizations
x-api-keystringRequired
authorizationstringRequired
Path parameters
eshopReturnIdstringRequired
Header parameters
x-api-keystringRequired

This is the eshop key you receive during onboarding.

authorizationstringRequired

Token you get from calling /users/login

Body
eshopReturnIdstringRequiredExample: eshopReturnId
eshopOrderIdstring · min: 1OptionalExample: eshopOrderId
notestringOptional
eshopNotestringOptional

Note from e-shop that is not shown to the customer

descriptionstring · min: 1OptionalExample: Wrong shoe size
shipperstring · min: 1OptionalExample: DHL
trackingNumberstring · min: 1OptionalExample: AB12345
shipperServiceCodestringOptionalExample: DHLEU
orderTypestring · enumRequiredExample: b2cPossible values:
canceledAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z
confirmedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z
receivedAtstring · dateOptionalExample: 2022-05-23T18:43:10.000Z
statusstring · enumOptional

You can update only to canceled status, other statuses are not allowed. This field is optional.

Possible values:
Responses
chevron-right
200

Success response

application/json
statusCodenumberRequiredDefault: 200
messagestringRequired
patch
/returns/{eshopReturnId}

Last updated