vocabulary: name: Snipcart API Vocabulary description: Terms and concepts used in the Snipcart REST API baseURL: https://app.snipcart.com/api version: '3.0' url: https://docs.snipcart.com/v3/api-reference/introduction resources: - name: Order description: A completed purchase transaction in Snipcart url: https://docs.snipcart.com/v3/api-reference/orders properties: - name: token type: string description: Unique identifier for the order - name: status type: string description: Current fulfillment status of the order values: [Processed, Disputed, Shipped, Delivered, Pending, Cancelled] - name: paymentStatus type: string description: Current payment status of the order values: [Paid, Deferred, PaidDeferred, ChargedBack, Refunded, Paidout, Failed, Pending, Cancelled, Open] - name: email type: string description: Email address of the customer who placed the order - name: total type: number description: Total order amount in the specified currency - name: currency type: string description: ISO 4217 currency code for the order - name: completionDate type: datetime description: Date and time the order was completed - name: trackingNumber type: string description: Shipment tracking number - name: trackingUrl type: string description: URL to the shipment tracking page - name: OrderItem description: A single product line within an order properties: - name: uniqueId type: string description: Unique identifier for the order item instance - name: id type: string description: Product identifier - name: name type: string description: Product name - name: price type: number description: Unit price of the item - name: quantity type: integer description: Quantity ordered - name: Customer description: A shopper who has placed at least one order url: https://docs.snipcart.com/v3/api-reference/customers properties: - name: id type: string description: Unique customer identifier assigned by Snipcart - name: email type: string description: Customer email address - name: billingAddressFirstName type: string description: Customer first name from billing address - name: billingAddressLastName type: string description: Customer last name from billing address - name: ordersCount type: integer description: Total number of orders placed by the customer - name: totalSpent type: number description: Cumulative amount spent by the customer - name: status type: string description: Customer account status values: [Confirmed, Unconfirmed] - name: creationDate type: datetime description: Date and time the customer account was created - name: Product description: A purchasable item tracked in the Snipcart catalog url: https://docs.snipcart.com/v3/api-reference/products properties: - name: id type: string description: Snipcart-generated unique product identifier - name: userDefinedId type: string description: Merchant-assigned product identifier - name: name type: string description: Product display name - name: price type: number description: Product price - name: url type: string description: URL of the page containing the product definition - name: description type: string description: Product description - name: stock type: integer description: Current available inventory count - name: allowOutOfStockPurchases type: boolean description: Whether purchases are allowed when stock is zero - name: totalSales type: integer description: Total number of units sold - name: Discount description: A promotional code or rule that reduces order cost url: https://docs.snipcart.com/v3/api-reference/discounts properties: - name: id type: string description: Unique discount identifier - name: name type: string description: Internal name for the discount - name: code type: string description: Discount code entered by the customer at checkout - name: type type: string description: Type of discount applied values: [FixedAmount, Rate, AlternatePrice, Shipping] - name: amount type: number description: Fixed monetary amount to deduct (for FixedAmount type) - name: rate type: number description: Percentage discount rate 0-100 (for Rate type) - name: maxNumberOfUsages type: integer description: Maximum total redemptions allowed - name: numberOfUsages type: integer description: Current count of redemptions - name: expirationDate type: datetime description: Date and time after which the discount cannot be used - name: Notification description: A message or email sent to a customer regarding their order url: https://docs.snipcart.com/v3/api-reference/notifications properties: - name: id type: string description: Unique notification identifier - name: type type: string description: Type of notification values: [OrderStatusChanged, Invoice, TrackingNumber, Comment, Custom] - name: deliveryMethod type: string description: How the notification is delivered values: [Email, None] - name: message type: string description: Custom message body of the notification - name: sentOn type: datetime description: Date and time the notification was sent - name: Refund description: A full or partial monetary return for a completed order url: https://docs.snipcart.com/v3/api-reference/refunds properties: - name: id type: string description: Unique refund identifier - name: amount type: number description: Amount refunded to the customer - name: comment type: string description: Reason or note for the refund - name: refundedOn type: datetime description: Date and time the refund was processed - name: AbandonedCart description: A shopping cart that was not completed into an order url: https://docs.snipcart.com/v3/api-reference/abandoned-carts properties: - name: token type: string description: Unique token identifying the abandoned cart - name: email type: string description: Email address of the shopper, if captured - name: total type: number description: Total value of items in the abandoned cart - name: currency type: string description: ISO 4217 currency code - name: creationDate type: datetime description: Date and time the cart was created - name: UserSession description: An authenticated shopper session in the Snipcart checkout url: https://docs.snipcart.com/v3/api-reference/user-sessions properties: - name: token type: string description: Unique session token - name: user type: object description: User details associated with the session - name: Domain description: A permitted domain from which the Snipcart cart may be loaded url: https://docs.snipcart.com/v3/api-reference/domains properties: - name: name type: string description: Domain name (e.g. example.com) - name: protocol type: string description: Protocol allowed for the domain values: [https, http] authentication: type: HTTP Basic Auth description: > All API requests require HTTP Basic Authentication using your secret API key as the username with an empty password. Base64-encode the credentials as {API_KEY}: and pass in the Authorization header. header: Authorization scheme: Basic url: https://docs.snipcart.com/v3/api-reference/authentication webhooks: description: Real-time event notifications for store activities url: https://docs.snipcart.com/v3/webhooks/introduction eventCategories: - Orders - Subscriptions - Shipping - Taxes pagination: description: > Most list endpoints support limit and offset query parameters for pagination. Default limit is 25 items. Abandoned carts use a continuation token pattern. parameters: - name: limit default: 25 - name: offset default: 0