Update Courier

This endpoint updates an order with shipping courier information. The Afterpay team may utilise this information when providing support.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

This endpoint updates an order with shipping courier information. The Afterpay team may utilise this information when providing support. ### Connection Timeouts | Timeout | Time (Seconds) | | ------- | ------------ | | Open | 10 | | Read | 20 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

environmentstringRequiredDefaults to api-sandbox

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

orderIdstringRequired

The unique Afterpay Order ID to update.

Request

This endpoint expects an object.

shippedAtstringOptional

The date and time when the order was shipped, in ISO 8601 format.

namestringOptional

The name of the shipping courier.

trackingstringOptional

The shipping tracking number provided by the courier.

prioritystringOptional

The shipping priority. If provided, must be either "STANDARD" or "EXPRESS".

Response

Returns a Payment object in response.

Errors

412

Precondition Failed Error

422

Unprocessable Entity Error

$	curl -X PUT https://global-api-sandbox.afterpay.com/v1/payments/orderId/courier/environment:api-sandbox \
>	-H "User-Agent: User-Agent" \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{}'

Connection Timeouts

Authentication

Path parameters

Headers

Request

Response

Errors

Connection Timeouts

Authentication

Path parameters

Headers

Request

Response

Errors