Products
Orders
curl --request POST \
--url https://api.snappy.com/v3/orders \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"accountId": "12345678",
"fundingSourceId": "87654321",
"variantId": "variant_abc123",
"recipient": {
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@example.com",
"phone": "+15551234567",
"shippingAddress": {
"line1": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"line2": "Apt 4B"
},
"externalId": "crm-user-987"
},
"idempotencyKey": "order-2026-05-13-abc",
"campaignId": "12345678",
"metadata": {
"externalOrderId": "ord-9981",
"source": "crm"
}
}
'{
"result": {
"orderId": "G7nR4bD9mK",
"status": "processing",
"trackingLink": "https://gift.snappy.com/choose/G7nR4bD9mK"
}
}Place an order
Places an order for a specific variant and recipient in a single idempotent call. Use this endpoint when you already know the recipient and the exact variant to ship.
Idempotency: pass a stable, caller-generated idempotencyKey (for
example, your internal order id). Replaying an identical request
returns the original order without creating a duplicate.
Campaigns: campaignId is optional. When omitted, the endpoint
selects a matching API campaign for the supplied fundingSourceId,
or creates one if none exists. Use GET /v3/campaigns to list
available campaigns.
Pricing: the endpoint resolves the variant’s price for the recipient’s shipping country. The funding source must be authorized for that price.
curl --request POST \
--url https://api.snappy.com/v3/orders \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"accountId": "12345678",
"fundingSourceId": "87654321",
"variantId": "variant_abc123",
"recipient": {
"firstname": "John",
"lastname": "Doe",
"email": "john.doe@example.com",
"phone": "+15551234567",
"shippingAddress": {
"line1": "123 Main St",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US",
"line2": "Apt 4B"
},
"externalId": "crm-user-987"
},
"idempotencyKey": "order-2026-05-13-abc",
"campaignId": "12345678",
"metadata": {
"externalOrderId": "ord-9981",
"source": "crm"
}
}
'{
"result": {
"orderId": "G7nR4bD9mK",
"status": "processing",
"trackingLink": "https://gift.snappy.com/choose/G7nR4bD9mK"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.snappy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Partner API key. Finalized per partner integration agreement.
Body
Request body for placing an order.
The id of the account placing the order. Must belong to the authenticated company.
"12345678"
The id of the funding source that will pay for the order. Must belong to the specified account.
"87654321"
The id of the product variant to ship to the recipient. Use the product/variant browse endpoints to discover variant ids.
1"variant_abc123"
The order recipient's details, including the shipping address to which the item will be delivered.
Show child attributes
Show child attributes
Unique caller-generated key used to deduplicate requests. Replaying an identical request returns the original order without creating a duplicate.
1 - 120"order-2026-05-13-abc"
Optional id of the API campaign under which the order is created. When omitted, an existing matching API campaign for the funding source is used, or one is created automatically.
"12345678"
Optional caller metadata. Up to 50 key-value pairs. Keys are alphanumeric (including underscores), up to 40 characters. Values are alphanumeric with limited special characters, up to 500 characters.
Show child attributes
Show child attributes
{
"externalOrderId": "ord-9981",
"source": "crm"
}Response
Order placed (or, on replay, the existing order).
Successful response returned after an order is placed.
Details of the placed order.
Show child attributes
Show child attributes
Was this page helpful?