---
title: "Update Checkout"
method: POST
path: "/checkout/{checkout_id}/update"
tags: ["Checkout"]
---

# Update 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

Update a checkout.

## Path parameters

- `checkout_id` string, required

## Request body

- UpdateCheckoutRequest
  - `order_id` string: 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_carrier` string, nullable: The shipping carrier used to ship the items.
  - `shipping_confirmation` string, nullable: The tracking number of the shipment.
  - `shipping` object, nullable: The shipping information. Required for scenarios where goods are shipped.
    - `address` object
      - `city` string: The name of the city.
      - `country` string: The abbreviated name of the country.
      - `line1` string: A U.S. street address.
      - `line2` string: The apartment number, floor or suite that complements the street address.
      - `state` string: The 2-letter postal abbreviation or full name of the U.S. state.
      - `zipcode` string: The 5-digit postal code of the address.
    - `email` string, nullable: The email address of the customer.
    - `name` object, nullable
      - `first` string: The first name of the customer.
      - `full` string: The full name of the customer, which must contain at least two words.
      - `last` string: The last name of the customer.
    - `phone_number` string, nullable: The phone number of the customer. It must be a valid U.S. phone number represented as a 10-digit string without any delimiters.

## Response `200`

HTTP 200 OK

- UpdateCheckout
  - `created` string: The date and time the update was created.
  - `order_id` string: Your internal order id. This is stored for your own reference.
  - `shipping_confirmation` string: A unique id for the shipping confirmation.
  - `shipping` object: The shipping information. Required for scenarios where goods are shipped.
    - `name` object
      - `full` string: The customer's name.
    - `address` object
      - `line1` string: A U.S. street address.
      - `line2` string: The apartment number, floor or suite that complements the street address.
      - `city` string: The name of the city.
      - `state` string: The 2-letter postal abbreviation or full name of the U.S. state.
      - `zipcode` string: The 5-digit postal code of the address.
      - `country` string: The abbreviated name of the country.
    - `email` string, nullable: The email address of the customer.
    - `phone_number` string, nullable: The phone number of the customer. It must be a valid U.S. phone number represented as a 10-digit string without any delimiters.
  - `shipping_carrier` string: The shipping carrier used to ship the items.
  - `type` string: The type of checkout request.
  - `id` string: A unique id representing the checkout request.

## Other responses

- `400`: HTTP 400 Bad Request
- `401`: HTTP 401 Unauthorized
- `404`: HTTP 404 Not Found

---

[API](https://skmtc.dev/affirm/apis/checkout-api.md) - [All operations](https://skmtc.dev/affirm/apis/checkout-api/llms.txt) - [OpenAPI document](https://skmtc.dev/affirm/apis/checkout-api/revisions/6f74c90a66df?raw)