Update Shipping Courier

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

Successful Response (200)

Returns a Payment object in response.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Errors

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

HTTP Status CodeerrorCodeDescription
422 <br />Unprocessable Entityinvalid_objectA 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".
412 <br />Precondition Failedprecondition_failedNo Clearpay Order was found matching the orderId provided.
put/v1/payments/{orderId}/courier

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v1/payments/{orderId}/courier
  • Auth: HTTP basic

Path parameters

orderIdstring required

The unique Clearpay Order ID to update.

Headers

User-Agentstring required
Acceptstring

Request body

shippedAtstring

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

namestring

The name of the shipping courier.

trackingstring

The shipping tracking number provided by the courier.

prioritystring

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

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.