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](/payment-object) in response. ## Connection Timeouts | Timeout | Time (Seconds) | | :------ | :------------- | | Open | 10 | | Read | 20 | ## Errors In addition to the [PUT/POST Errors](/put-post-errors) applicable to all PUT endpoints, the following errors are specific to Update Shipping Courier: | HTTP Status Code | errorCode | Description | | :-- | :-- | :-- | | **412** <br />Precondition Failed | `precondition_failed` | No Clearpay Order was found matching the `orderId` provided. | | **422** <br />Unprocessable Entity | `invalid_object` | A value for `shippedAt` was provided, but not a valid [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) date. Or, a value for `priority` was provided, but wasn't one of "STANDARD" or "EXPRESS". |

Authentication

AuthorizationBasic

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