Cancel an order
Orders
Cancel an order
Use this endpoint to cancel an order that has not yet been processed or shipped. Use this when the recipient or sender requests a cancellation before the shipment is in transit.
Required fields
giftId- the Gift identifier whose Order should be cancelled, passed as a path parameter
Optional parameters
companyIdquery parameter - Company identifier, when not inferable from the API key contextRequest-Sourceheader - source of the request
Behavior Notes
- Cancels the active Order on the Gift and returns the cancelled Order ID with
status: cancelled. - Orders can only be cancelled before they are processed or shipped. Once a shipment is in transit, cancellation returns an error and the request is rejected.
- A new Order can be placed against the same Gift after cancellation by calling
POST /v2/gifts/{giftId}/claimagain with a different variant or address. - The Billing Method is credited back when the Order is successfully cancelled.
Permissions
- Requires:
orders:cancel
POST
Cancel an order
Authorizations
Company Level Authentication
Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.
Getting Your API Key
- Create an API Key: Use the
POST /v2/authentication/apiKeysendpoint to generate a new API key - Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
- Optional mTLS: Enable mutual TLS for enhanced security
- Name Your Key: Provide a descriptive name for easy identification
Using Your API Key
Include your API key in the X-Api-Key header for every request:
X-Api-Key: YOUR_24_CHARACTER_API_KEYAPI Key Management
- Maximum Keys: Up to 3 active API keys per company
- Rotation: Delete old keys before creating new ones when at the limit
- Security: Keys are hashed and cannot be retrieved after creation
Enhanced Security (mTLS)
For production environments, enable mutual TLS authentication:
- Set
enforceMtls: truewhen creating the API key - Contact support to obtain your client certificates
- Use the mTLS endpoint:
https://mtls-api.snappy.com/public-api
Headers
Source of the request
Available options:
api_native, api_zapier, api_salesforce, api_ftp, api_make Example:
"api_native"
Path Parameters
The id of the gift.
Pattern:
^[A-Za-z0-9]{8,}$Example:
"abc123de"
Query Parameters
Company ID
Pattern:
^[A-Za-z0-9]{8,}$Example:
"12345678"
Last modified on June 17, 2026