7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

Overview

Submits a delivery address change request for a shipment and selected action. Carries payment and scheduling preferences required to apply address updates.

Request builder

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

requestSource?Source

Value in

"Web"
"Mobile"

awb*string

Length1 <= length

selectedAction*CustomerAction

Value in

"None"
"PayForDelivery"
"BranchPickUp"
"PudoPickUp"
"PayOnly"

preferredOfficeId?string

paymentStatus?ShipmentPaymentStatus

Value in

"Paid"
"UnPaid"
"Failed"

updatedAddress?

paymentReference?string

totalAmount?number

Formatdouble

preferredDate?string

Formatdate-time

preferredTimeFrom?string

preferredTimeTo?string

saveCreditCard?boolean

isDefualtCard?boolean

paymentProperties?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Shipments/UpdateAddress" \  -H "Content-Type: application/json" \  -d '{    "awb": "string",    "selectedAction": "None"  }'

{  "statusCode": 0}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`