AFaffirm
Checkout

Update Checkout

Update a checkout.

post/checkout/{checkout_id}/update

Request

  • Base URL
    https://sandbox.affirm.com/api/v2
  • URL
    https://sandbox.affirm.com/api/v2/checkout/{checkout_id}/update
  • Auth
    HTTP basic

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

createdstring

The date and time the update was created.

order_idstring

Your internal order id. This is stored for your own reference.

shipping_confirmationstring

A unique id for the shipping confirmation.

shipping_carrierstring

The shipping carrier used to ship the items.

typestring

The type of checkout request.

idstring

A unique id representing the checkout request.

Example response

{
  "created": "2021-10-13T20:48:13.000Z",
  "order_id": "ABC123",
  "shipping_confirmation": "1Z23223",
  "shipping": {
    "name": {
      "full": "John Doe"
    },
    "address": {
      "line1": "123 Example Street",
      "line2": "Apt 123",
      "city": "San Francisco",
      "state": "CA",
      "zipcode": "94107",
      "country": "USA"
    },
    "email": "test@example.com",
    "phone_number": "1234567890"
  },
  "shipping_carrier": "USPS",
  "type": "update",
  "id": "4V776PBJV0DFH0G8"
}

Changes

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