Payments

Update Shipping 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 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <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.

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json

Request

This endpoint expects an object.
shippedAtstringOptional
The date and time when the order was shipped, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) 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