Delete Return

DELETE 
https://api.goodsdelivery.io/v1/returns/:id

Authorization: x-api-key

name: x-api-keytype: apiKeyscopes: brandin: header

To cancel a scheduled return pick-up issue a DELETE request, where you use the ShortId or ID in the request as the ID of the return in order to match your request with an return delivery.

Request

Path Parameters

id stringrequired

ID of the return to delete

Responses

200

If the request is valid, a successful response will be provided.

application/json

Schema

Schema

success booleanrequired

Example (from schema)

{
  "success": true
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired

Human readable error message.

code stringrequired

Machine readable error message.

more url

More help on the error here.

Example (from schema)

{
  "message": "string",
  "code": "string",
  "more": "string"
}

403

Can not delete

application/json

Schema

Schema

message stringrequired

Human readable error message.

code stringrequired

Machine readable error message.

more url

More help on the error here.

Example (from schema)

{
  "message": "string",
  "code": "string",
  "more": "string"
}

404

Return not found

application/json

Schema

Schema

message stringrequired

Human readable error message.

code stringrequired

Machine readable error message.

more url

More help on the error here.

Example (from schema)

{
  "message": "string",
  "code": "string",
  "more": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X DELETE 'https://api.goodsdelivery.io/v1/returns/:id' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://api.goodsdelivery.io/v1

Auth

Security Scheme

APIKeyHeaderAuthorizationHeader

APIKeyHeader

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!