Update Return

PUT 
https://api.goodsdelivery.io/v1/returns

Authorization: x-api-key

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

To update an existing return issue a PUT request. Your body should include a JSON object with the requested changes, where you use the ShortId or ID in the request as the ID of the return in order to match your request with an existing return.

Request

application/json

Body

required

In the request you can provide values only for the properties that you want to update

id stringrequired

ID of the job

pickUp object

name string

Company name

address1 stringrequired

address2 string

city stringrequired

zipCode stringrequired

state stringrequired

2 letter state code - ISO 3166-2

country stringrequired

2 letter country code - ISO 3166-2

note string

Address note - how to get there, etc.

dropOff object

name string

Company name

address1 stringrequired

address2 string

city stringrequired

zipCode stringrequired

state stringrequired

2 letter state code - ISO 3166-2

country stringrequired

2 letter country code - ISO 3166-2

note string

Address note - how to get there, etc.

consumer object

firstName stringrequired

lastName stringrequired

phone phone

Phone is required when email is not provided

email email

Email is required when phone is not provided

contactlessPreferred boolean

Defines if the costumer prefer contactless delivery

addons Addon[]

Possible values: [EXTRA_INSURANCE, SIGNATURE_REQUIRED, WITHOUT_LABEL]

Add-ons for the delivery service

serviceType ServiceType

Possible values: [SAME_DAY, NEXT_DAY, SCHEDULED]

Determine the delivery date, including pick-up and drop-off times.

scheduledDate date-time

Required if serviceType is SCHEDULED. Date in ISO 8601 format

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 update

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 PUT 'https://api.goodsdelivery.io/v1/returns' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "id": "string",
  "pickUp": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zipCode": "string",
    "state": "string",
    "country": "string",
    "note": "string"
  },
  "dropOff": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zipCode": "string",
    "state": "string",
    "country": "string",
    "note": "string"
  },
  "consumer": {
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com"
  },
  "contactlessPreferred": true,
  "addons": [
    "EXTRA_INSURANCE"
  ],
  "serviceType": "SAME_DAY",
  "scheduledDate": "2023-06-02"
}'

Request Collapse all

Base URL

https://api.goodsdelivery.io/v1

Auth

Security Scheme

APIKeyHeaderAuthorizationHeader

APIKeyHeader

Body required

{
  "id": "string",
  "pickUp": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zipCode": "string",
    "state": "string",
    "country": "string",
    "note": "string"
  },
  "dropOff": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "zipCode": "string",
    "state": "string",
    "country": "string",
    "note": "string"
  },
  "consumer": {
    "firstName": "string",
    "lastName": "string",
    "phone": "string",
    "email": "user@example.com"
  },
  "contactlessPreferred": true,
  "addons": [
    "EXTRA_INSURANCE"
  ],
  "serviceType": "SAME_DAY",
  "scheduledDate": "2023-06-02"
}

ResponseClear

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