Skip to main content
POST
/
execution
/
sell
/
v1
Execute a sell order
curl --request POST \
  --url https://api.collectpure.com/execution/sell/v1 \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "quoteId": "<string>",
  "expectedTotal": 4503599627370495,
  "selectedOptionalIds": [
    "<string>"
  ],
  "adjustListings": true,
  "confirmListingMismatch": true
}
'
{
  "success": true,
  "data": {
    "status": "complete",
    "orderId": 123,
    "items": [
      {
        "lineItemId": "<string>",
        "productId": "<string>",
        "variantId": "<string>",
        "quantity": 123,
        "price": 123,
        "total": 123,
        "success": true
      }
    ],
    "checkout": {
      "lineItems": [
        {
          "id": "<string>",
          "quantity": 123,
          "price": 123,
          "status": "<string>",
          "disabled": true,
          "error": "<string>",
          "product": {
            "sku": "<string>",
            "title": "<string>"
          },
          "variant": {
            "title": "<string>"
          }
        }
      ],
      "fees": [
        {
          "id": "<string>",
          "label": "<string>",
          "amount": 123,
          "rate": 123
        }
      ],
      "subtotal": 123,
      "total": 123
    }
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
quoteId
string
required

The quote ID from /execution/sell/quote/v1

expectedTotal
integer
required

The total from the quote response, in cents. The order is rejected if the current total is less than this value (protects against payout decreases).

Required range: 0 <= x <= 9007199254740991
selectedOptionalIds
string[]

Optional IDs to confirm (e.g. instant payout). Must match the selections from the quote.

adjustListings
boolean

When true, decrements the seller's active listings for the same products during checkout

confirmListingMismatch
boolean

When true, skips the error when sell quantity is less than listed quantity

Response

200 - application/json

Default Response

success
enum<boolean>
required
Available options:
true
data
object
required