Skip to navigation
Online APIOrder Management

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
412
Precondition Failed		precondition_failedNo Clearpay Order was found matching the orderId provided.
422
Unprocessable Entity		invalid_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”.

Authentication

AuthorizationBasic

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

Path parameters

orderIdstringRequired
The unique Clearpay 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 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".