Skip to main content
Documentation Powered by Redocly

Checkout Frontend (2.0)

Download OpenAPI specification:Download

URL: https://developer.boldcommerce.com/default/contactus Terms of Service

The Checkout Frontend API is used to interact with an order. This includes the ability to get and manipulate order details from a browser.

Refer to the changelog for the latest updates to this API.

For more information about Checkout, refer to the Overview.

Authentication

JWT

Authenticates the API request. The expected token is a JSON Web Token (JWT) generated during the initialization of the the order via the Initialize Order endpoint.

Once the JWT expires (after 60 minutes), you must generate a new JWT using the Refresh JWT for Order endpoint.

Security Scheme Type API Key
Header parameter name: JWT

Addresses

A child of the Order resource. Contains information about shipping and billing addresses. Use these endpoints to add shipping and billing addresses to an order.

Set Shipping Address

Sets the shipping address on the order.

Each order can have only one shipping address. If you call this endpoint and a shipping address already exists, the existing address will be overwritten.

Authorizations:
JWT
    path Parameters
    shop_identifier
    required
    string

    The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

    public_order_id
    required
    string

    The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

    header Parameters
    Authorization
    required
    string <Bearer JWT>
    Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

    Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

    Request Body schema: application/json
    first_name
    string

    First Name.

    last_name
    string

    Last Name.

    address_line_1
    string

    Street Address.

    address_line_2
    string

    Additional Street address details(apt #, suite #, etc).

    country
    required
    string

    Country Name.

    city
    string

    City Name.

    province
    string

    Province name if exists.

    country_code
    required
    string

    ISO 3166 country code.

    province_code
    string

    ISO 3166 Province code if exists.

    postal_code
    string

    Postal/Zip code.

    business_name
    string

    Business Name.

    phone_number
    string

    Phone Number.

    Responses

    Request samples

    Content type
    application/json
    {
    • "id": "12",
    • "first_name": "Dorris",
    • "last_name": "Parker",
    • "address_line_1": "331 2nd Street",
    • "address_line_2": "Apt 2",
    • "country": "Canada",
    • "city": "Winnipeg",
    • "province": "Manitoba",
    • "country_code": "CA",
    • "province_code": "MB",
    • "postal_code": "R0A 0Y0",
    • "business_name": "Bold",
    • "phone_number": "800-555-102"
    }

    Response samples

    Content type
    application/json
    {
    • "data": {
      }
    }

    Update Shipping Address

    Updates the shipping address on the order.

    This endpoint updates all fields of the shipping address associated with the order, and any value left blank in this request body will be made blank in the updated address. The fields country, country_code, province, and province_code cannot be left blank.

    Note: If taxes have already been calculated, changes to the shipping address may affect those calculations. Taxes are not recalculated automatically, so you must call the Generate Taxes endpoint to recalculate taxes for the order.

    Authorizations:
    JWT
      path Parameters
      shop_identifier
      required
      string

      The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

      public_order_id
      required
      string

      The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

      header Parameters
      Authorization
      required
      string <Bearer JWT>
      Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

      Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

      Request Body schema: application/json
      first_name
      string

      First Name.

      last_name
      string

      Last Name.

      address_line_1
      string

      Street Address.

      address_line_2
      string

      Additional Street address details(apt #, suite #, etc).

      country
      required
      string

      Country Name.

      city
      string

      City Name.

      province
      string

      Province name if exists.

      country_code
      required
      string

      ISO 3166 country code.

      province_code
      string

      ISO 3166 Province code if exists.

      postal_code
      string

      Postal/Zip code.

      business_name
      string

      Business Name.

      phone_number
      string

      Phone Number.

      Responses

      Request samples

      Content type
      application/json
      {
      • "id": "12",
      • "first_name": "John",
      • "last_name": "Doe",
      • "address_line_1": "50 Fultz Blvd",
      • "address_line_2": "This place",
      • "country": "Canada",
      • "city": "Winnipeg",
      • "province": "Manitoba",
      • "country_code": "CA",
      • "province_code": "MB",
      • "postal_code": "R3L0L6",
      • "business_name": "Bold",
      • "phone_number": "8005550101"
      }

      Response samples

      Content type
      application/json
      {
      • "data": {
        }
      }

      Delete Shipping Address

      Clears the shipping address from the order.

      Note: If taxes have already been calculated, changes to the shipping address may affect those calculations. Taxes are not recalculated automatically, so you must call the Generate Taxes endpoint to recalculate taxes for the order.

      Authorizations:
      JWT
        path Parameters
        shop_identifier
        required
        string

        The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

        public_order_id
        required
        string

        The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

        header Parameters
        Authorization
        required
        string <Bearer JWT>
        Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

        Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

        Responses

        Response samples

        Content type
        application/json
        {
        • "data": {
          }
        }

        Get Shipping Address

        Gets the shipping address on the order.

        Authorizations:
        JWT
          path Parameters
          shop_identifier
          required
          string

          The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

          public_order_id
          required
          string

          The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

          header Parameters
          Authorization
          required
          string <Bearer JWT>
          Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

          Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

          Responses

          Response samples

          Content type
          application/json
          {
          • "data": {
            }
          }

          Set Billing Address

          Sets the billing address on the order.

          Each order can have only one billing address. If you call this endpoint and a billing address already exists, the existing address will be overwritten.

          Authorizations:
          JWT
            path Parameters
            shop_identifier
            required
            string

            The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

            public_order_id
            required
            string

            The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

            header Parameters
            Authorization
            required
            string <Bearer JWT>
            Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

            Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

            Request Body schema: application/json
            first_name
            string

            First Name.

            last_name
            string

            Last Name.

            address_line_1
            string

            Street Address.

            address_line_2
            string

            Additional Street address details(apt #, suite #, etc).

            country
            required
            string

            Country Name.

            city
            string

            City Name.

            province
            string

            Province name if exists.

            country_code
            required
            string

            ISO 3166 country code.

            province_code
            string

            ISO 3166 Province code if exists.

            postal_code
            string

            Postal/Zip code.

            business_name
            string

            Business Name.

            phone_number
            string

            Phone Number.

            Responses

            Request samples

            Content type
            application/json
            {
            • "first_name": "Dorris",
            • "last_name": "Smith",
            • "address_line_1": "1000 S 42nd St",
            • "address_line_2": "",
            • "country": "United States",
            • "city": "Grand Forks",
            • "province": "North Dakota",
            • "country_code": "US",
            • "province_code": "ND",
            • "postal_code": "58201",
            • "business_name": "Blue Company",
            • "phone_number": "800-555-0107"
            }

            Response samples

            Content type
            application/json
            {
            • "data": {
              }
            }

            Update Billing Address

            Updates the billing address on the order.

            This endpoint updates all fields of the billing address associated with the order, and any value left blank in this request body will be made blank in the updated address. The fields country, country_code, province, and province_code cannot be left blank.

            Authorizations:
            JWT
              path Parameters
              shop_identifier
              required
              string

              The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

              public_order_id
              required
              string

              The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

              header Parameters
              Authorization
              required
              string <Bearer JWT>
              Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

              Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

              Request Body schema: application/json
              first_name
              string

              First Name.

              last_name
              string

              Last Name.

              address_line_1
              string

              Street Address.

              address_line_2
              string

              Additional Street address details(apt #, suite #, etc).

              country
              required
              string

              Country Name.

              city
              string

              City Name.

              province
              string

              Province name if exists.

              country_code
              required
              string

              ISO 3166 country code.

              province_code
              string

              ISO 3166 Province code if exists.

              postal_code
              string

              Postal/Zip code.

              business_name
              string

              Business Name.

              phone_number
              string

              Phone Number.

              Responses

              Request samples

              Content type
              application/json
              {
              • "first_name": "Joe",
              • "last_name": "Bold",
              • "address_line_1": "123 Street",
              • "address_line_2": "Apt",
              • "country": "Canada",
              • "city": "Winnipeg",
              • "province": "Manitoba",
              • "country_code": "CA",
              • "province_code": "MB",
              • "postal_code": "R3T 6B1",
              • "business_name": "Bold",
              • "phone_number": "800-555-0102"
              }

              Response samples

              Content type
              application/json
              {
              • "data": {
                }
              }

              Delete Billing Address

              Clears the billing address from the order.

              Authorizations:
              JWT
                path Parameters
                shop_identifier
                required
                string

                The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                public_order_id
                required
                string

                The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                header Parameters
                Authorization
                required
                string <Bearer JWT>
                Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                Responses

                Response samples

                Content type
                application/json
                {
                • "data": {
                  }
                }

                Get Billing Address

                Get the billing address that is set on the Order.

                Authorizations:
                JWT
                  path Parameters
                  shop_identifier
                  required
                  string

                  The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                  public_order_id
                  required
                  string

                  The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                  header Parameters
                  Authorization
                  required
                  string <Bearer JWT>
                  Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                  Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                  Responses

                  Response samples

                  Content type
                  application/json
                  No sample

                  Validate Address

                  Validates if the given postal code matches up with postal codes from Canada, US, Ireland, Great Britain, France or Singapore. If the address is in Canada or the US, this endpoint also validates the state/province provided.

                  Calling this endpoint does not change the application state or apply the address. While not required, it can be helpful to call this endpoint before calling the Set Shipping Address or the Set Billing Address endpoints if you want to implement custom error handling in more complicated address scenarios. Calling the Set Shipping Address and the Set Billing Address endpoints applies the same validations applied by this endpoint.

                  Authorizations:
                  JWT
                    path Parameters
                    shop_identifier
                    required
                    string

                    The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                    public_order_id
                    required
                    string

                    The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                    query Parameters
                    firstName
                    string
                    Example: firstName=John

                    First name.

                    lastName
                    string
                    Example: lastName=Doe

                    Last name.

                    address_line_1
                    string
                    Example: address_line_1=50 Fultz Blvd

                    Street address.

                    address_line_2
                    string
                    Example: address_line_2=Apt 21

                    Additional street address details (apt #, suite #, etc).

                    city
                    string
                    Example: city=Winnipeg

                    City name.

                    province
                    string
                    Example: province=Manitoba

                    Province/state name, if applicable. Required for certain countries, including the United States and Canada.

                    province_code
                    string
                    Example: province_code=MB

                    Province/state code in ISO 3166 format, if applicable. Required for certain countries, including the United States and Canada.

                    postal_code
                    string >= 2 characters
                    Example: postal_code=R3Y 0L6

                    Postal/zip code. Required for most countries, including the United States, Canada, and Mexico. Validated on format only when provided.

                    country
                    required
                    string
                    Example: country=Canada

                    Country name.

                    country_code
                    required
                    string >= 2 characters
                    Example: country_code=CA

                    Country code, in ISO 3166 format.

                    business_name
                    string
                    Example: business_name=ACME Inc.

                    Business name. Required when marked as such in the shop's general settings.

                    phone_number
                    string
                    Example: phone_number=2041234569

                    Phone number. Required when marked as such in the shop's general settings.

                    header Parameters
                    Authorization
                    required
                    string <Bearer JWT>
                    Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                    Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                    Responses

                    Response samples

                    Content type
                    application/json
                    {
                    • "data": [ ]
                    }

                    Customers

                    A child of the Order resource. Contains information about guest customers on your store, including name and email. Use these endpoints to add or remove a guest customer to an order.

                    Delete Customer

                    Delete the customer from the order.

                    Authorizations:
                    JWT
                      path Parameters
                      shop_identifier
                      required
                      string

                      The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                      public_order_id
                      required
                      string

                      The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                      header Parameters
                      Authorization
                      required
                      string <Bearer JWT>
                      Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                      Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                      Responses

                      Response samples

                      Content type
                      application/json
                      {
                      • "data": {
                        }
                      }

                      Get Customer

                      Gets the customer data set on the order.

                      Authorizations:
                      JWT
                        path Parameters
                        shop_identifier
                        required
                        string

                        The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                        public_order_id
                        required
                        string

                        The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                        header Parameters
                        Authorization
                        required
                        string <Bearer JWT>
                        Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                        Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                        Responses

                        Response samples

                        Content type
                        application/json
                        {
                        • "data": {
                          }
                        }

                        Update Customer

                        Updates the customer on the order provided from the Initialize Order, the Create Authenticated Customer and the Create Guest Customer endpoints.

                        Authorizations:
                        JWT
                          path Parameters
                          shop_identifier
                          required
                          string

                          The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                          public_order_id
                          required
                          string

                          The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                          header Parameters
                          Authorization
                          required
                          string <Bearer JWT>
                          Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                          Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                          Request Body schema: application/json
                          first_name
                          required
                          string

                          The customer's first name.

                          last_name
                          required
                          string

                          The customer's last name.

                          email_address
                          required
                          string

                          The customer's email address.

                          accepts_marketing
                          boolean
                          Default: false

                          If the customer would like to receive any sort of marketing emails.

                          Responses

                          Request samples

                          Content type
                          application/json
                          {
                          • "first_name": "string",
                          • "last_name": "string",
                          • "email_address": "string",
                          • "accepts_marketing": false
                          }

                          Response samples

                          Content type
                          application/json
                          {
                          • "data": {
                            }
                          }

                          Create Guest Customer

                          Creates a new guest customer.

                          Cannot create a customer when a customer was already provided by the Initialize Order endpoint or the Create Authenticated Customer endpoint.

                          If you wish to add a new guest customer to an order or add an authenticated customer you must first delete the existing customer using the Delete Customer endpoint.

                          Authorizations:
                          JWT
                            path Parameters
                            shop_identifier
                            required
                            string

                            The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                            public_order_id
                            required
                            string

                            The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                            header Parameters
                            Authorization
                            required
                            string <Bearer JWT>
                            Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                            Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                            Request Body schema: application/json
                            first_name
                            required
                            string

                            The customer's first name.

                            last_name
                            required
                            string

                            The customer's last name.

                            email_address
                            required
                            string

                            The customer's email address.

                            accepts_marketing
                            boolean
                            Default: false

                            If the customer would like to receive any sort of marketing emails.

                            Responses

                            Request samples

                            Content type
                            application/json
                            {
                            • "first_name": "string",
                            • "last_name": "string",
                            • "email_address": "string",
                            • "accepts_marketing": false
                            }

                            Response samples

                            Content type
                            application/json
                            {
                            • "data": {
                              }
                            }

                            Update Guest Customer Deprecated

                            Updates the guest customer on the order.

                            Cannot update customer data that was provided from the Initialize Order endpoint.

                            Authorizations:
                            JWT
                              path Parameters
                              shop_identifier
                              required
                              string

                              The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                              public_order_id
                              required
                              string

                              The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                              header Parameters
                              Authorization
                              required
                              string <Bearer JWT>
                              Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                              Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                              Request Body schema: application/json
                              first_name
                              required
                              string

                              The customer's first name.

                              last_name
                              required
                              string

                              The customer's last name.

                              email_address
                              required
                              string

                              The customer's email address.

                              accepts_marketing
                              boolean
                              Default: false

                              If the customer would like to receive any sort of marketing emails.

                              Responses

                              Request samples

                              Content type
                              application/json
                              {
                              • "first_name": "string",
                              • "last_name": "string",
                              • "email_address": "string",
                              • "accepts_marketing": false
                              }

                              Response samples

                              Content type
                              application/json
                              {
                              • "data": {
                                }
                              }

                              Validate Email Address

                              Validates the email address and performs an MX check to make sure the domain can accept email. Does not validate the the email address exists on the domain.

                              Authorizations:
                              JWT
                                path Parameters
                                shop_identifier
                                required
                                string

                                The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                public_order_id
                                required
                                string

                                The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                query Parameters
                                email_address
                                required
                                string
                                Example: email_address=john.smith@gmail.com

                                The email address to be validated.

                                header Parameters
                                Authorization
                                required
                                string <Bearer JWT>
                                Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                Responses

                                Response samples

                                Content type
                                application/json
                                {
                                • "data": [ ]
                                }

                                Discounts

                                Contains information about discount codes that have been applied to an order. Use these endpoints to manipulate discount codes on an order.

                                Validate Discount Code

                                Validates the given discount code against the current order state and shop settings. This will not change the application state or apply the discount. It is not required to call this endpoint before calling the Add Discount Code endpoint, but it can be helpful if you want to implement custom error handling in more complicated discount code scenarios.

                                For more information about discount validation, refer to Validate Discount Codes.

                                Authorizations:
                                JWT
                                  path Parameters
                                  shop_identifier
                                  required
                                  string

                                  The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                  public_order_id
                                  required
                                  string

                                  The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                  query Parameters
                                  discount_code
                                  required
                                  string
                                  Example: discount_code=TESTCODE

                                  The discount code to be validated.

                                  header Parameters
                                  Authorization
                                  required
                                  string <Bearer JWT>
                                  Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                  Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                  Responses

                                  Response samples

                                  Content type
                                  application/json
                                  {
                                  • "data": { }
                                  }

                                  List Discounts

                                  Get all the discount codes applied to the order.

                                  Authorizations:
                                  JWT
                                    path Parameters
                                    shop_identifier
                                    required
                                    string

                                    The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                    public_order_id
                                    required
                                    string

                                    The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                    header Parameters
                                    Authorization
                                    required
                                    string <Bearer JWT>
                                    Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                    Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                    Responses

                                    Response samples

                                    Content type
                                    application/json
                                    {
                                    • "data": {
                                      }
                                    }

                                    Add Discount Code

                                    Applies a discount code to the current order. If the discount code is valid, the order and application state will be updated to reflect the applied discount. It is not required to call the Validate Discount Code endpoint before calling this endpoint.

                                    For more information about discount validation, refer to Validate Discount Codes.

                                    Authorizations:
                                    JWT
                                      path Parameters
                                      shop_identifier
                                      required
                                      string

                                      The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                      public_order_id
                                      required
                                      string

                                      The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                      header Parameters
                                      Authorization
                                      required
                                      string <Bearer JWT>
                                      Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                      Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                      Request Body schema: application/json
                                      code
                                      required
                                      string

                                      The discount code.

                                      Responses

                                      Request samples

                                      Content type
                                      application/json
                                      {
                                      • "code": "string"
                                      }

                                      Response samples

                                      Content type
                                      application/json
                                      {
                                      • "data": {
                                        }
                                      }

                                      Delete Discount Code

                                      Removes the discount code and its discounts from the order.

                                      Authorizations:
                                      JWT
                                        path Parameters
                                        shop_identifier
                                        required
                                        string

                                        The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                        public_order_id
                                        required
                                        string

                                        The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                        header Parameters
                                        Authorization
                                        required
                                        string <Bearer JWT>
                                        Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                        Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                        Request Body schema: application/json
                                        code
                                        required
                                        string

                                        The discount code.

                                        Responses

                                        Request samples

                                        Content type
                                        application/json
                                        {
                                        • "code": "string"
                                        }

                                        Response samples

                                        Content type
                                        application/json
                                        {
                                        • "data": {
                                          }
                                        }

                                        Line Items

                                        A child of the Order resource. Contains information about the product and the taxes, fees, and discounts associated with it. Use these endpoints to manipulate line items on an order.

                                        Add Line Item

                                        Adds a new item to the order. Only products that have already been sync'd to Checkout can be added from the frontend. One of either the SKU or the product ID is required.

                                        Authorizations:
                                        JWT
                                          path Parameters
                                          shop_identifier
                                          required
                                          string

                                          The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                          public_order_id
                                          required
                                          string

                                          The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                          header Parameters
                                          Authorization
                                          required
                                          string <Bearer JWT>
                                          Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                          Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                          Request Body schema: application/json
                                          platorm_id
                                          string

                                          Id of the product on the platform

                                          sku
                                          string
                                          quantity
                                          required
                                          integer
                                          line_item_key
                                          required
                                          string

                                          Key used to refer to the line

                                          Responses

                                          Request samples

                                          Content type
                                          application/json
                                          {
                                          • "platform_id": "71",
                                          • "sku": "CLC",
                                          • "quantity": 1,
                                          • "line_item_key": "key1"
                                          }

                                          Response samples

                                          Content type
                                          application/json
                                          {
                                          • "data": {
                                            }
                                          }

                                          List Line Items

                                          Get a list of all the items on the order. This is a duplication of the line_items provided by the application_state.

                                          Authorizations:
                                          JWT
                                            path Parameters
                                            shop_identifier
                                            required
                                            string

                                            The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                            public_order_id
                                            required
                                            string

                                            The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                            header Parameters
                                            Authorization
                                            required
                                            string <Bearer JWT>
                                            Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                            Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                            Responses

                                            Response samples

                                            Content type
                                            application/json
                                            {
                                            • "data": {
                                              }
                                            }

                                            Update Line Item Quantity

                                            Only the quantity of the product can be adjusted from the frontend. Refer to the line to be updated by line_item_key.

                                            Authorizations:
                                            JWT
                                              path Parameters
                                              shop_identifier
                                              required
                                              string

                                              The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                              public_order_id
                                              required
                                              string

                                              The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                              header Parameters
                                              Authorization
                                              required
                                              string <Bearer JWT>
                                              Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                              Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                              Request Body schema: application/json
                                              platorm_id
                                              string

                                              Id of the product on the platform

                                              sku
                                              string
                                              quantity
                                              required
                                              integer
                                              line_item_key
                                              required
                                              string

                                              Key used to refer to the line

                                              Responses

                                              Request samples

                                              Content type
                                              application/json
                                              {
                                              • "quantity": 1,
                                              • "line_item_key": "key1"
                                              }

                                              Response samples

                                              Content type
                                              application/json
                                              {
                                              • "data": {
                                                }
                                              }

                                              Delete Line Item

                                              Removes a line item. Refer to the line to remove by line_item_key.

                                              Authorizations:
                                              JWT
                                                path Parameters
                                                shop_identifier
                                                required
                                                string

                                                The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                public_order_id
                                                required
                                                string

                                                The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                header Parameters
                                                Authorization
                                                required
                                                string <Bearer JWT>
                                                Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                Request Body schema: application/json
                                                platorm_id
                                                string

                                                Id of the product on the platform

                                                sku
                                                string
                                                quantity
                                                required
                                                integer
                                                line_item_key
                                                required
                                                string

                                                Key used to refer to the line

                                                Responses

                                                Request samples

                                                Content type
                                                application/json
                                                {
                                                • "platform_id": "121",
                                                • "sku": "OCG",
                                                • "quantity": 1,
                                                • "line_item_key": "oak_cheese_grater_0"
                                                }

                                                Response samples

                                                Content type
                                                application/json
                                                {
                                                • "data": {
                                                  }
                                                }

                                                Metadata

                                                A child of the Order resource. Contains metadata about the order, including cart parameters, note attributes, nots, and tags. Use these endpoints to manipulate the metadata on an order.

                                                Append Order Metadata

                                                Append to any of the metadata attached to an order.

                                                Authorizations:
                                                JWT
                                                  path Parameters
                                                  shop_identifier
                                                  required
                                                  string

                                                  The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                  public_order_id
                                                  required
                                                  string

                                                  The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                  header Parameters
                                                  Authorization
                                                  required
                                                  string <Bearer JWT>
                                                  Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                  Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                  Request Body schema: application/json
                                                  Cart parameters (object) or No cart parameters (array)

                                                  Extra information about an order that Checkout can act upon.

                                                  Note attributes (object) or No note attributes (array)

                                                  Extra information added to the order and pushed to the platform.

                                                  notes
                                                  string

                                                  Notes that can be attached to the order.

                                                  tags
                                                  Array of strings

                                                  Tags attached to the order.

                                                  Responses

                                                  Request samples

                                                  Content type
                                                  application/json
                                                  Example
                                                  {
                                                  • "cart_parameters": {
                                                    },
                                                  • "note_attributes": {
                                                    },
                                                  • "notes": "A different delivery instruction.",
                                                  • "tags": [
                                                    ]
                                                  }

                                                  Response samples

                                                  Content type
                                                  application/json
                                                  {
                                                  • "order_meta_data": {
                                                    },
                                                  • "application_state": {
                                                    }
                                                  }

                                                  Clear Order Metadata

                                                  Clears the order of all the metadata.

                                                  Authorizations:
                                                  JWT
                                                    path Parameters
                                                    shop_identifier
                                                    required
                                                    string

                                                    The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                    public_order_id
                                                    required
                                                    string

                                                    The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                    header Parameters
                                                    Authorization
                                                    required
                                                    string <Bearer JWT>
                                                    Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                    Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                    Responses

                                                    Response samples

                                                    Content type
                                                    application/json
                                                    {
                                                    • "application_state": {
                                                      }
                                                    }

                                                    List Order Metadata

                                                    List All the Metadata Attached to an Order.

                                                    Authorizations:
                                                    JWT
                                                      path Parameters
                                                      shop_identifier
                                                      required
                                                      string

                                                      The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                      public_order_id
                                                      required
                                                      string

                                                      The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                      header Parameters
                                                      Authorization
                                                      required
                                                      string <Bearer JWT>
                                                      Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                      Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                      Responses

                                                      Response samples

                                                      Content type
                                                      application/json
                                                      Example
                                                      {
                                                      • "order_meta_data": {
                                                        },
                                                      • "application_state": {
                                                        }
                                                      }

                                                      Overwrite Order Metadata

                                                      Add Metadata to an Order.

                                                      Authorizations:
                                                      JWT
                                                        path Parameters
                                                        shop_identifier
                                                        required
                                                        string

                                                        The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                        public_order_id
                                                        required
                                                        string

                                                        The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                        header Parameters
                                                        Authorization
                                                        required
                                                        string <Bearer JWT>
                                                        Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                        Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                        Request Body schema: application/json

                                                        Any existing metadata will be overwritten by the values provided in this request.

                                                        Cart parameters (object) or No cart parameters (array)

                                                        Extra information about an order that Checkout can act upon.

                                                        Note attributes (object) or No note attributes (array)

                                                        Extra information added to the order and pushed to the platform.

                                                        notes
                                                        string

                                                        Notes that can be attached to the order.

                                                        tags
                                                        Array of strings

                                                        Tags attached to the order.

                                                        Responses

                                                        Request samples

                                                        Content type
                                                        application/json
                                                        {
                                                        • "cart_parameters": {
                                                          },
                                                        • "note_attributes": {
                                                          },
                                                        • "notes": "Special delivery instruction.",
                                                        • "tags": [
                                                          ]
                                                        }

                                                        Response samples

                                                        Content type
                                                        application/json
                                                        {
                                                        • "order_meta_data": {
                                                          },
                                                        • "application_state": {
                                                          }
                                                        }

                                                        Orders

                                                        Contains information about a single order, including the full application state of the order. Use these endpoints to retrieve the application state, manipulate order metadata, process the order, and complete other order-related functions.

                                                        Process Order

                                                        Triggers the backend processing of the order.

                                                        Before processing the order, Bold completes a series of pre-processing checks to ensure taxes are calculated and the order contains payments that equal the order total.

                                                        During processing, Bold completes the following steps:

                                                        • Verify that inventory is adequate to fulfill the order (optional, based on platform settings).
                                                        • Pre-authorize any pending payments.
                                                        • Finalize and apply discounts.

                                                        If these steps complete successfully, this endpoint returns a success message.

                                                        Once order processing is complete, Bold asynchronously pushes each order to the platform and charges authorized payments.

                                                        Authorizations:
                                                        JWT
                                                          path Parameters
                                                          shop_identifier
                                                          required
                                                          string

                                                          The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                          public_order_id
                                                          required
                                                          string

                                                          The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                          header Parameters
                                                          Authorization
                                                          required
                                                          string <Bearer JWT>
                                                          Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                          Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                          Responses

                                                          Response samples

                                                          Content type
                                                          application/json
                                                          {
                                                          • "application_state": {
                                                            }
                                                          }

                                                          Pre-Process Order

                                                          Prompts Bold Checkout to execute all the checks required before processing an order. These steps include an inventory check, order validation and payment authorization.

                                                          Authorizations:
                                                          JWT
                                                            path Parameters
                                                            shop_identifier
                                                            required
                                                            string

                                                            The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                            public_order_id
                                                            required
                                                            string

                                                            The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                            header Parameters
                                                            Authorization
                                                            required
                                                            string <Bearer JWT>
                                                            Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                            Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                            Responses

                                                            Response samples

                                                            Content type
                                                            application/json
                                                            {
                                                            • "application_state": {
                                                              }
                                                            }

                                                            Get Application State

                                                            Gets a refreshed copy of the application state. Useful if there are other plugins or applications that might be interacting with the order.

                                                            Authorizations:
                                                            JWT
                                                              path Parameters
                                                              shop_identifier
                                                              required
                                                              string

                                                              The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                              public_order_id
                                                              required
                                                              string

                                                              The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                              header Parameters
                                                              Authorization
                                                              required
                                                              string <Bearer JWT>
                                                              Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                              Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                              Responses

                                                              Response samples

                                                              Content type
                                                              application/json
                                                              {
                                                              • "data": {
                                                                }
                                                              }

                                                              Dispatch App Hook Event

                                                              Dispatches the app_hook plugin event to the plugin with the matching client ID provided in the request (given this plugin is registered for the app_hook event). For more information about the app_hook event, refer to Create Custom Events with App Hooks.

                                                              The plugin processes the request, and returns a response that indicates the actions to be executed by Checkout. Checkout completes these actions, and this endpoint then returns an up-to-date version of the application_state.

                                                              Authorizations:
                                                              JWT
                                                                path Parameters
                                                                shop_identifier
                                                                required
                                                                string

                                                                The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                public_order_id
                                                                required
                                                                string

                                                                The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                header Parameters
                                                                Authorization
                                                                required
                                                                string <Bearer JWT>
                                                                Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                Request Body schema: application/json
                                                                uuid
                                                                required
                                                                string

                                                                The unique identifier of the plugin that is expected to receive the app_hook event. The client ID was sent to the developer upon creation of the plugin.

                                                                hook
                                                                required
                                                                string

                                                                The name of the app_hook event to send to the plugin.

                                                                app_hook_data
                                                                object

                                                                Data that will be provided as part of the app_hook plugin Event payload.

                                                                Responses

                                                                Request samples

                                                                Content type
                                                                application/json
                                                                {
                                                                • "uuid": "93225ea4-d701-41f9-a30a-bfe66f5d0479",
                                                                • "hook": "age_verified",
                                                                • "app_hook_data": {
                                                                  }
                                                                }

                                                                Response samples

                                                                Content type
                                                                application/json
                                                                {
                                                                • "application_state": {
                                                                  }
                                                                }

                                                                Check Order Inventory

                                                                Triggers an inventory check on the items in the cart. The check can only be performed if the store enabled inventory checks; otherwise, this endpoint returns a not_enabled response. Functionally, this means that Checkout may proceed as if the check had passed.

                                                                If the inventory check is enabled, Checkout looks for an inventory override present on the order. If one is present, Checkout calls the override endpoint and returns the results yielded by that endpoint. If no override is present, Checkout uses the inventory policy on the store platform to determine whether the items on the order are in stock. For more information about inventory overrides, refer to the Plugin Actions Reference.

                                                                If Checkout is able to complete the inventory check, it returns a result of either pass or fail depending on the result of the check. If the result is fail, Checkout also returns a list of the items that failed the check, along with their available quantities.

                                                                If Checkout is unable to complete the inventory check for some external reason (for example, due to a network failure), Checkout returns an error response indicating that the check could not be completed.

                                                                Authorizations:
                                                                JWT
                                                                  path Parameters
                                                                  shop_identifier
                                                                  required
                                                                  string

                                                                  The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                  public_order_id
                                                                  required
                                                                  string

                                                                  The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                  query Parameters
                                                                  stage
                                                                  string
                                                                  Default: "initial"
                                                                  Enum: "initial" "final"

                                                                  The context in which the inventory check is to be performed. Specify this value only when using an inventory override. The override provider must interpret this value, as it has no impact on Bold Checkout functionality. Allowable values are initial or final. For most use cases, the value should be initial to indicate that the order has not been processed. Checkout automatically performs an inventory check when an order is being processed and uses the value final if an inventory override is place at this time.

                                                                  header Parameters
                                                                  Authorization
                                                                  required
                                                                  string <Bearer JWT>
                                                                  Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                  Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                  Responses

                                                                  Response samples

                                                                  Content type
                                                                  application/json
                                                                  {
                                                                  • "inventory_check": {
                                                                    },
                                                                  • "application_state": {
                                                                    }
                                                                  }

                                                                  Payments

                                                                  A child of the Order resource. Contains information about the payments on an order. Use these endpoints to manipulate the payments on an order.

                                                                  List Payments

                                                                  Lists the payments that have been applied to the order.

                                                                  Authorizations:
                                                                  JWT
                                                                    path Parameters
                                                                    shop_identifier
                                                                    required
                                                                    string

                                                                    The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                    public_order_id
                                                                    required
                                                                    string

                                                                    The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                    header Parameters
                                                                    Authorization
                                                                    required
                                                                    string <Bearer JWT>
                                                                    Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                    Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                    Responses

                                                                    Response samples

                                                                    Content type
                                                                    application/json
                                                                    {
                                                                    • "data": {
                                                                      }
                                                                    }

                                                                    Create Payment

                                                                    Adds a new payment to the order.

                                                                    The payment gateway_public_id tells Bold Checkout which payment gateway to use and is therefore required. The token key is also required.

                                                                    The amount is optional. If this value is left empty, Bold Checkout sets the payment amount to the order total or to the maximum value that the payment method supports (e.g., for a gift card payment).

                                                                    Authorizations:
                                                                    JWT
                                                                      path Parameters
                                                                      shop_identifier
                                                                      required
                                                                      string

                                                                      The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                      public_order_id
                                                                      required
                                                                      string

                                                                      The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                      header Parameters
                                                                      Authorization
                                                                      required
                                                                      string <Bearer JWT>
                                                                      Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                      Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                      Request Body schema: application/json
                                                                      gateway_public_id
                                                                      required
                                                                      string

                                                                      Public identifier of the payment gateway used with the payment.

                                                                      amount
                                                                      number

                                                                      The payment amount represented in cents/base currency units using ISO-4217 standards.

                                                                      currency
                                                                      string
                                                                      type
                                                                      string
                                                                      display_string
                                                                      string

                                                                      String to visually display the payment to the customer.

                                                                      token
                                                                      required
                                                                      string

                                                                      Token generated by the payment gateway to identify the payment.

                                                                      retain
                                                                      boolean
                                                                      Default: false

                                                                      Whether the payment method will be saved for future orders. Checkout only stores a tokenized version of the payment method.

                                                                      Responses

                                                                      Request samples

                                                                      Content type
                                                                      application/json
                                                                      {
                                                                      • "gateway_public_id": "string",
                                                                      • "amount": 0,
                                                                      • "currency": "string",
                                                                      • "type": "string",
                                                                      • "display_string": "string",
                                                                      • "token": "string",
                                                                      • "retain": false
                                                                      }

                                                                      Response samples

                                                                      Content type
                                                                      application/json
                                                                      {
                                                                      • "data": {
                                                                        }
                                                                      }

                                                                      Update Payment

                                                                      Updates the value of the payment. Only the amount of payment can be changed.

                                                                      Authorizations:
                                                                      JWT
                                                                        path Parameters
                                                                        shop_identifier
                                                                        required
                                                                        string

                                                                        The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                        public_order_id
                                                                        required
                                                                        string

                                                                        The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                        header Parameters
                                                                        Authorization
                                                                        required
                                                                        string <Bearer JWT>
                                                                        Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                        Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                        Request Body schema: application/json
                                                                        gateway_public_id
                                                                        required
                                                                        string

                                                                        Public identifier of the payment gateway used with the payment.

                                                                        amount
                                                                        number

                                                                        The payment amount represented in cents/base currency units using ISO-4217 standards.

                                                                        currency
                                                                        string
                                                                        type
                                                                        string
                                                                        display_string
                                                                        string

                                                                        String to visually display the payment to the customer.

                                                                        token
                                                                        required
                                                                        string

                                                                        Token generated by the payment gateway to identify the payment.

                                                                        retain
                                                                        boolean
                                                                        Default: false

                                                                        Whether the payment method will be saved for future orders. Checkout only stores a tokenized version of the payment method.

                                                                        Responses

                                                                        Request samples

                                                                        Content type
                                                                        application/json
                                                                        {
                                                                        • "gateway_public_id": "string",
                                                                        • "amount": 0,
                                                                        • "currency": "string",
                                                                        • "type": "string",
                                                                        • "display_string": "string",
                                                                        • "token": "string",
                                                                        • "retain": false
                                                                        }

                                                                        Response samples

                                                                        Content type
                                                                        application/json
                                                                        {
                                                                        • "data": {
                                                                          }
                                                                        }

                                                                        Remove Payment

                                                                        Removes the payment by token.

                                                                        Authorizations:
                                                                        JWT
                                                                          path Parameters
                                                                          shop_identifier
                                                                          required
                                                                          string

                                                                          The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                          public_order_id
                                                                          required
                                                                          string

                                                                          The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                          header Parameters
                                                                          Authorization
                                                                          required
                                                                          string <Bearer JWT>
                                                                          Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                          Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                          Request Body schema: application/json
                                                                          gateway_public_id
                                                                          required
                                                                          string

                                                                          Public identifier of the payment gateway used with the payment.

                                                                          amount
                                                                          number

                                                                          The payment amount represented in cents/base currency units using ISO-4217 standards.

                                                                          currency
                                                                          string
                                                                          type
                                                                          string
                                                                          display_string
                                                                          string

                                                                          String to visually display the payment to the customer.

                                                                          token
                                                                          required
                                                                          string

                                                                          Token generated by the payment gateway to identify the payment.

                                                                          retain
                                                                          boolean
                                                                          Default: false

                                                                          Whether the payment method will be saved for future orders. Checkout only stores a tokenized version of the payment method.

                                                                          Responses

                                                                          Request samples

                                                                          Content type
                                                                          application/json
                                                                          {
                                                                          • "gateway_public_id": "string",
                                                                          • "amount": 0,
                                                                          • "currency": "string",
                                                                          • "type": "string",
                                                                          • "display_string": "string",
                                                                          • "token": "string",
                                                                          • "retain": false
                                                                          }

                                                                          Response samples

                                                                          Content type
                                                                          application/json
                                                                          {
                                                                          • "data": {
                                                                            }
                                                                          }

                                                                          Remove Gift Card Payment

                                                                          Removes a gift card payment by ID.

                                                                          Authorizations:
                                                                          JWT
                                                                            path Parameters
                                                                            shop_identifier
                                                                            required
                                                                            string

                                                                            The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                            public_order_id
                                                                            required
                                                                            string

                                                                            The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                            header Parameters
                                                                            Authorization
                                                                            required
                                                                            string <Bearer JWT>
                                                                            Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                            Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                            Request Body schema: application/json
                                                                            id
                                                                            string

                                                                            The ID of the gift card payment. Find the ID by reading the application state payments array. Refer to Get Application State.

                                                                            Responses

                                                                            Request samples

                                                                            Content type
                                                                            application/json
                                                                            {
                                                                            • "id": "2"
                                                                            }

                                                                            Response samples

                                                                            Content type
                                                                            application/json
                                                                            {
                                                                            • "data": {
                                                                              }
                                                                            }

                                                                            Payment Iframes

                                                                            Contains information about the Payment Isolation Gateway Interface (PIGI). Use these endpoints to manipulate the PIGI iFrame.

                                                                            Create CSS Styling for PIGI

                                                                            Use this endpoint to style the PIGI using CSS and media queries.

                                                                            Authorizations:
                                                                            JWT
                                                                              path Parameters
                                                                              shop_identifier
                                                                              required
                                                                              string

                                                                              The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                              public_order_id
                                                                              required
                                                                              string

                                                                              The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                              header Parameters
                                                                              Authorization
                                                                              required
                                                                              string <Bearer JWT>
                                                                              Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                              Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                              Request Body schema: application/json
                                                                              Array of objects[ items ]

                                                                              A set of CSS rules to be applied.

                                                                              Array of objects[ items ]

                                                                              A set of media queries to be applied to the PIGI iframe.

                                                                              Responses

                                                                              Request samples

                                                                              Content type
                                                                              application/json
                                                                              {
                                                                              • "css_rules": [
                                                                                ],
                                                                              • "media_rules": [
                                                                                ]
                                                                              }

                                                                              Response samples

                                                                              Content type
                                                                              application/json
                                                                              {
                                                                              • "css_rules": [
                                                                                ],
                                                                              • "media_rules": [
                                                                                ]
                                                                              }

                                                                              Shipping Lines

                                                                              A child of the Order resource. Contains information about the order's shipping line, which is created via the Bold Checkout admin. Use these endpoints to manipulate the shipping lines set on an order.

                                                                              Set Shipping Line

                                                                              Sets the shipping line to one of the available shipping lines on the order. Shipping lines can only be set by index and cannot be set directly.

                                                                              Authorizations:
                                                                              JWT
                                                                                path Parameters
                                                                                shop_identifier
                                                                                required
                                                                                string

                                                                                The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                                public_order_id
                                                                                required
                                                                                string

                                                                                The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                                header Parameters
                                                                                Authorization
                                                                                required
                                                                                string <Bearer JWT>
                                                                                Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                                Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                                Request Body schema: application/json
                                                                                index
                                                                                string

                                                                                The index of a shipping line that was previously retrieved using the List Shipping Lines endpoint.

                                                                                Responses

                                                                                Request samples

                                                                                Content type
                                                                                application/json
                                                                                {
                                                                                • "index": "0"
                                                                                }

                                                                                Response samples

                                                                                Content type
                                                                                application/json
                                                                                {
                                                                                • "data": {
                                                                                  }
                                                                                }

                                                                                List Shipping Lines

                                                                                Retrieves the shipping lines that are configured in Checkout.

                                                                                Authorizations:
                                                                                JWT
                                                                                  path Parameters
                                                                                  shop_identifier
                                                                                  required
                                                                                  string

                                                                                  The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                                  public_order_id
                                                                                  required
                                                                                  string

                                                                                  The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                                  header Parameters
                                                                                  Authorization
                                                                                  required
                                                                                  string <Bearer JWT>
                                                                                  Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                                  Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                                  Responses

                                                                                  Response samples

                                                                                  Content type
                                                                                  application/json
                                                                                  No sample

                                                                                  Taxes

                                                                                  A child of the Order resource. Contains information about order-level taxes. Use these endpoints to generate order-level taxes.

                                                                                  Generate Taxes

                                                                                  Calculates and applies taxes to the order. Taxes are not automatically recalculated, so you must call this endpoint after you make any changes to the shipping address.

                                                                                  Before calling this endpoint, configure your store's tax settings in the Bold Checkout admin, including tax zones, the tax provider, and whether the price of shipping should be taxed.

                                                                                  Taxes are calculated for each line item, for the shipping (if applicable), and for the whole order — the returned application_state reflects all of these calculations.

                                                                                  Bold recommends calling this endpoint after calling the Set Shipping Line endpoint. In addition, calculated taxes must be present in the application_state before you call the Process Order endpoint. Otherwise, the API returns an error and does not process the order.

                                                                                  Authorizations:
                                                                                  JWT
                                                                                    path Parameters
                                                                                    shop_identifier
                                                                                    required
                                                                                    string

                                                                                    The identifier of the shop. Can be retrieved by making a request to the Get Info endpoint.

                                                                                    public_order_id
                                                                                    required
                                                                                    string

                                                                                    The public order id generated when the order is initialized by making a request to the Initialize Order endpoint.

                                                                                    header Parameters
                                                                                    Authorization
                                                                                    required
                                                                                    string <Bearer JWT>
                                                                                    Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJWMl9BUEkiLCJwYXlsb2FkIjp7InB1YmxpY19vcmRlcl9pZCI6Inlyb0Y2NDNNeUpTZVZRUUpES2R2c2QxYXdXY3BpRVFJbkhOaTJkWlhmWW9PdVI0dmFGVUhpNHBPRG9pRWFpOVQifSwiZXhwIjoxNjMyMzQxMjg3LCJuYmYiOm51bGwsImlhdCI6bnVsbH0.swmYcVBHyK2i86jN-bIOL3WOCzP5VQVLq9Ev-TfIC_c

                                                                                    Authenticates the API request. The expected token is a JWT generated during the initialization of the the order via the Initialize Order endpoint. Once the JWT has expired (after 60 minutes), a new JWT can be regenerated using the Refresh JWT endpoint.

                                                                                    Responses

                                                                                    Response samples

                                                                                    Content type
                                                                                    application/json
                                                                                    {
                                                                                    • "data": {
                                                                                      }
                                                                                    }