RYrye-com
Checkout Intents

List checkout intents

Changed on

Retrieve a paginated list of checkout intents

Enables developers to query checkout intents associated with their account, with filters and cursor-based pagination.

get/api/v1/checkout-intents

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/checkout-intents
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Maximum number of results to return (default 100)

afterstring
beforestring
idstring[]
stateCheckoutIntentState[]

Response

Paginated checkout intents response

Example response

{
  "data": [
    {
      "referenceId": "order-1234",
      "constraints": {
        "maxShippingPrice": 500,
        "maxTotalPrice": 100000
      },
      "promoCodes": [
        "SAVE20"
      ],
      "variantSelections": [
        {
          "label": "Size, Color, etc."
        }
      ],
      "buyer": {
        "postalCode": "10001",
        "country": "US",
        "province": "NY",
        "city": "New York",
        "address2": "Apt 1",
        "address1": "123 Main St",
        "phone": "1234567890",
        "email": "john.doe@example.com",
        "lastName": "Doe",
        "firstName": "John"
      }
    }
  ]
}

Changes

  • cd4a7aa2308bRevision changes
    • info

      removed from the //// response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status

  • f2236504ec75Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status