Sign in

v1

latestOpenAPI 3.0.02026-07-262561105.1 KB
Checkout

Update Checkout

Update a checkout.

post/checkout/{checkout_id}/update

Path parameters

checkout_idstring required

A checkout_token that represents the purchase and customer information on purchase (e.g tokenization).

Request body

order_idstring

Identifies the order within the merchant's order management system that this transaction corresponds to. It is only returned in the response if included in the request.

shipping_carrierstring nullable

The shipping carrier used to ship the items.

shipping_confirmationstring nullable

The tracking number of the shipment.

Example request

{
  "order_id": "A1B2C3D4",
  "shipping_carrier": "USPS",
  "shipping_confirmation": "C12345678901234",
  "shipping": {
    "address": {
      "city": "San Francisco",
      "country": "USA",
      "line1": "123 Example Street",
      "line2": "Apt 123",
      "state": "CA",
      "zipcode": "94107"
    },
    "email": "test@example.com",
    "phone_number": "1234567890"
  }
}

Response

HTTP 200 OK