Update Shipping Courier

put https://global-api-sandbox.afterpay.com/v2/payments/{orderId}/courier

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

Successful Response (200)

Returns a Payment object in response.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

Errors

In addition to the PUT/POST Errors applicable to all PUT endpoints, the following errors are specific to Update Shipping Courier:

HTTP Status Code	errorCode	Description
412 Precondition Failed	`precondition_failed`	No Afterpay Order was found matching the `orderId` provided.
422 Unprocessable Entity	`invalid_object`	A value for `shippedAt` was provided, but not a valid ISO 8601 date. Or, a value for `priority` was provided, but wasn't one of "STANDARD" or "EXPRESS".

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://global-api-sandbox.afterpay.com/v2/payments/orderId/courier \
3
     --header 'Accept: application/json' \
4
     --header 'Content-Type: application/json' \
5
     --header 'User-Agent: Readme.io API Simulator'

Click Try It! to start a request and see the response here!