Skip to main content
POST
/
cart
/
details
Cart Details
curl --request POST \
  --url https://api.henrylabs.ai/v1/cart/details \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cartId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "buyer": {
    "shippingAddress": {
      "line1": "123 Main St",
      "line2": "Apt 4B",
      "city": "Anytown",
      "province": "CA",
      "postalCode": "12345",
      "countryCode": "US"
    }
  },
  "coupons": [
    "SUMMER21",
    "FREESHIP"
  ]
}
'
{
  "success": true,
  "status": "<string>",
  "message": "<string>",
  "data": {
    "jobs": [
      {
        "refId": "<string>",
        "status": "pending",
        "result": {
          "items": [
            {
              "shippingOptions": [
                {
                  "id": "<string>",
                  "name": "<string>",
                  "cost": {
                    "value": 123,
                    "currency": "USD"
                  },
                  "timeEstimate": "<string>",
                  "minDate": "<string>",
                  "maxDate": "<string>"
                }
              ],
              "costs": {
                "subtotal": {
                  "value": 123,
                  "currency": "USD"
                },
                "total": {
                  "value": 123,
                  "currency": "USD"
                },
                "tax": {
                  "value": 123,
                  "currency": "USD"
                },
                "shipping": {
                  "value": 123,
                  "currency": "USD"
                },
                "discount": {
                  "value": 123,
                  "currency": "USD"
                }
              },
              "coupons": [
                {
                  "code": "<string>",
                  "available": true,
                  "savedAmount": {
                    "value": 123,
                    "currency": "USD"
                  }
                }
              ],
              "metadata": {}
            }
          ]
        },
        "error": {}
      }
    ],
    "metadata": {}
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
cartId
string<uuid>
required

Unique identifier for the cart

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

buyer
object
required
coupons
string[]

List of coupon codes applied to the cart

Example:
["SUMMER21", "FREESHIP"]
metadata
object

Additional metadata for the request

Response

Cart detail jobs queued successfully, use refIds to check status and retrieve results

success
boolean
required
status
string
required
message
string
required
data
object
required