Defaults to attribute name underscored. List of values applicable to checkbox , radio , dropdown and image attributes. Returns a new attribute if valid arguments are provided, otherwise returns an object containing validation errors. The attribute id is always returned. Update an existing attribute using the ID, that was returned when created. Returns the updated attribute if valid arguments are provided, otherwise returns an object containing validation errors.
Returns the original attribute if the operation was successful, or null if the attribute was not found. A cart is a pending request to purchase products from your store.
Carts contain all the information needed to fulfill a purchase. Once the customer is ready to complete their purchase, a simple API call is made to convert a cart to an order. Fields id objectid Unique identifier for the cart. Indicates the cart was abandoned after 3 hours of inactivity. After being marked as abandoned, this field is automatically set back to false after an update to items, billing or shipping info.
Indicates the customer chose to save shipping and billing information to their account when submitting the order.
The customer's billing details. Defaults to account. Updating billing will also update the corresponding account billing object. Token generated by Swell Checkout or Stripe. When used with a payment gateway that performs address checks and address1 was provided, can be pass , fail , unavailable or unchecked. Credit card brand. When used with a payment gateway that performs CVC code checks and cvc was provided, can be pass , fail , unavailable or unchecked.
When used with a payment gateway that performs address checks and zip was provided, can be pass , fail , unavailable or unchecked. Billing first name. Billing last name. Method of payment. Can be card , account , amazon , paypal or any one of the manual methods defined in payment settings. Billing full name. URL to checkout for the cart, set automatically when the cart has at least items , shipping , or billing details set. Can also be set explicitly when creating or updating the cart for custom checkouts.
Next date the cart will be marked as abandoned when using a series of abandoned cart recovery notices a. Date the order webhook first failed, if applicable. Value is unset after an order webhook is successfully returned for the record. Type of discount. Custom discounts don't require this value. Three-letter ISO currency code representing the user's preferred display currency, if applicable.
Amount of the gift card balance to spend for initial payment. If not specified, each gift cards will be spent in order until payment is completed. Total quantity of the bundle item to be fulfilled, calculated as item.
List of discounts applied to the item by coupons , promotions or custom logic. Unique identifier for the object. Refers to one of the IDs in the cart discounts object. Arbitrary item data, typically set in a checkout flow to store custom values. See Swell. Item options matching one or more of product.
When adding to the cart, specify either option id or name case-insensitive to identify the option. Gift card products have two special options that can be used when fulfilling gift cards by email. Name value of the product option.
When adding to the cart, specify either the product option value id or name case-insensitive to identify the value. Original item price used internally to determine if the item price was overridden and should be automatically updated when item options are changed. Price of the item. If a product price is reduced by a sale or price rule, this would be set to the reduced price automatically.
Also, item price can be overridden when adding to a cart. Line item prices don't change unless explicitly edited by a store admin. Refers to one of the IDs in the cart taxes object. Arbitrary data, typically set in a checkout flow to store custom values. Unique incremental cart number, assigned automatically using a format configured in general settings.
Shipping discount applied by coupons , promotions or custom logic. Object describing the shipping services and rates available for the cart. Shipping country must be set before retrieving shipping rates. List of errors generated while retrieving rates, if any.
When using 3rd party shipping services, any system errors will be listed here. Unique fingerprint identifying the parameters used to calculate shipping rates. Rates should always be the same given the same parameters and shipping settings.
The customer's shipping details. Updating shipping will also update the corresponding account shipping object. Shipping first name. Shipping last name. Shipping full name. Price of the shipping service. ID of a shipping service as configured in shipment settings. Name of the shipping service. Current status of the cart. Can be active , converted , abandoned or recovered. Total with shipping and item taxes included. Priority indicates the order in which a tax rule was applied.
Higher priority rules are added on top of other tax rules with a lower priority. Rules with the same priority are calculated excluding each other. Number of failed order webhook attempts, if applicable.
Text response of the last failed order webhook attempt, if applicable. HTTP response status of the last failed order webhook attempt, if applicable. Setting this value will populate billing. Set a valid coupon code to apply the coupon's discount. If the code is not found or invalid, a validation error is returned. List of discounts to apply to the item. Normally populated by applying a coupon or promotions. Should refer to one of the IDs in the cart discounts object.
Override this value to set a custom price. Defaults to product price or sale price. Should refer to one of the IDs in the cart taxes object. Setting this value will populate shipping with the associated customer's account address on file. When applying gift cards to a cart, optionally indicate the total amount to spend from all gift cards applied. Specifying an amount greater than the total available will return a validation error.
Set true when the customer has indicated they want to save shipping and billing information to their account for future use. Set true when the customer has logged in with a password before submitting the order. This affects whether the order is considered as a guest checkout. Amount of the gift card balance to spend on this order.
Defaults to giftcard. Specify a gift card code to apply to the cart. Set true when the cart is a guest checkout. Set true to indicate the cart was recovered and converted to an order after being abandoned. Returns a new cart if valid arguments are provided, otherwise returns an object containing validation errors. The cart id is always returned. Update an existing cart using the ID that was returned when created.
Returns the updated cart if valid arguments are provided, otherwise returns an object containing validation errors. Create a new order from an active cart. This call Will map items and other properties from a cart while creating the order and mark the cart as converted. Returns an error if any of the required order properties are missing from the cart, or if product stock is unavailable. Returns the original cart if the operation was successful, or null if the cart was not found.
An order is a request to purchase products from a store. Orders contain all the information needed to fulfill a purchase. Usually, customers create a cart to stage a purchase first, and see it converted to an order when it's finalized.
Besides being converted from a cart, it is possible to create an order directly. Fields id objectid Unique identifier for the order. ID of an authorized payment. When "Require payment authorization" is enabled in payment settings, the order will be rejected if initial payment fails.
Indicates the order was completely fulfilled. Total quantity of line items that can be fulfilled by gift card. Applies when item. Total quantity of line items that can be fulfilled by shipment. Total quantity of line items that can be fulfilled by subscription. Quantity of the bundle item that can be fulfilled by a gift card. Quantity of the bundle item that can be fulfilled by a shipment. Quantity of the bundle item that can be fulfilled by a subscription.
Refers to one of the IDs in the order discounts object. When adding to the order, you can specify the either option id or name case-insensitive to identify the option. Subscription products have three special options that are used when fulfilling subscriptions.
Customer message to send a gift card with, used when item product has a gift card purchase option. Subscription billing interval, used when item product has a subscription purchase option. Can be monthly , daily , weekly or yearly. Multiplier for subscription billing interval, used when item product has a subscription purchase option.
When adding to the order, specify either the product option value id or name case-insensitive to identify the value. Also, item price can be overridden when adding to an order. Quantity of the item that can be fulfilled by a gift card. Quantity of the item that can be fulfilled by a shipment. Quantity of the item that can be fulfilled by a subscription. Indicates the item has been fulfilled as a subscription and marked as paid by reference to this order.
Refers to one of the IDs in the order taxes object. Unique incremental order number, assigned automatically using a format configured in general settings. Indicates the order was paid in full. Balance of payments. A negative number indicates payment is owed, while a positive balance indicates refund is due. Zero balance indicates fully paid. Indicates the order was fully refunded. Object describing the shipping services and rates available for the order.
Total shipping price including taxes and discount. Current status of the order. Set to a valid coupon code to apply the coupon's discount. Should refer to one of the IDs in the order discounts object. Should refer to one of the IDs in the order taxes object. When applying gift cards to an order, optionally indicate the total amount to spend from all gift cards applied.
Set true to cancel the order, notifying the customer by email and returning stock quantity if applicable. Specify a gift card code to apply to the order. Set true when the order is placed by guest checkout. Set true to put the order "on hold" and prevent automated fulfillment, if applicable.
Returns a new order if valid arguments are provided, otherwise returns an object containing validation errors. The order id is always returned. Update an existing order using the ID that was returned when created. Returns the updated order if valid arguments are provided, otherwise returns an object containing validation errors. Returns the original order if the operation was successful, or null if the order was not found. When a store accepts payment of any kind, a record is kept along with its relation to an order or invoice.
Related orders and invoices are automatically updated with payment totals. Fields id objectid Unique identifier for the payment. Expandable link to the customer's credit card on file used to make the payment, if applicable. Indicates the payment is processed asynchronously. The payment will be updated in the future while success is undefined. A temp token generated by Swell Checkout or Stripe.
An object describing an error that occurred while interacting with the payment gateway, if applicable. Status of the payment. Can be pending , error , success or authorized. A pending payment is awaiting async processing. Indicates the payment was successful. When an error occurs with a payment gateway, this status will be false and error field will be populated.
ID of an invoice to apply the payment to, if applicable. ID of a customer's credit card to make the payment with. Returns a new payment if valid arguments are provided, otherwise returns an object containing validation errors. The payment id is always returned. Issue a refund to an existing payment. Available refund up to the original payment amount with any number of calls. Returns a new refund if valid arguments are provided, otherwise returns an object containing validation errors.
Refunds are issued against a payment. The sum of refunds can't exceed the total payment amount. Related orders and invoices are automatically updated with refund totals. Fields id objectid Unique identifier for the refund. Method of refund. Defaults to the original payment method. Indicates the refund is processed asynchronously. The refund will be updated in the future while success is undefined. Status of the refund. Can be pending , error or success.
A pending refund is awaiting async processing. Indicates the refund was successful. When an error occurs with a payment gateway, this value will be false and error field will be populated. To issue a refund, create a refund with the amount and method to return to the customer. A refund can be issued with a different method than the original payment. The total amount refunded can't exceed the total payment amount.
The refund id is always returned. A shipment represents physical fulfillment of a number of items after an order is placed. Shipments contain information about items being fulfilled, and shipping details such as address and tracking number. Fields id objectid Unique identifier for the shipment. Type of package.
This value can be enumerated, representing the types of packages used by the fulfillment provider. Returns a new shipment if valid arguments are provided, otherwise returns an object containing validation errors.
Returns the updated shipment if valid arguments are provided, otherwise returns an object containing validation errors. The shipment id is always returned.
A return is an action normally requested by a customer to return products purchased from a store. They contain information about returning items that were previously fulfilled, the return shipment details if applicable, and return value to apply to an order, which in turn may prompt an administrator to issue a refund.
Fields id objectid Unique identifier for the return. Returns a new return if valid arguments are provided, otherwise returns an object containing validation errors. Returns the updated return if valid arguments are provided, otherwise returns an object containing validation errors.
The return id is always returned. Subscriptions allow to charge a customer on a recurring basis. A subscription ties a customer to a particular subscription plan. In addition to the plan, a subscriptions can have line items that are charged on a recurring basis or just once, depending on particular use case. API docs. Query Parameters where object An object containing criteria to filter results by. A number indicating the max number of results to return up to An object with additional queries to include as fields in the result.
List of products sold as a bundle. Discount to apply as a fixed amount. Discount to apply as a percentage. Type of discount to apply, either fixed or percent. Method of fulfillment automatically assigned based on type. A brief description of the image, intended for display as a caption or alt text. A public URL to reference the file. Updated automatically if file content changes. Indicates whether the option requires a value when the product is added to a cart.
Indicates whether the option specifies the billing interval of a subscription plan. A brief description of the option value, intended for displaying to customers. Fixed amount to add when rule is applied. Arguments name required Human-friendly name of the product. Set true to enable custom options for this product in the admin panel. Set true to generate variants for this product in the admin panel. Returns Returns a new product if valid arguments are provided, otherwise returns an object containing validation errors.
Arguments id required ID of the product to retrieve. Returns Returns a product if a valid ID was provided. Otherwise null. Arguments id required Unique identifier for the product. Returns Returns the updated product if valid arguments are provided, otherwise returns an object containing validation errors.
Arguments expand optional Expanding link fields and child collections is performed using the expand argument. Limit the number of records returned, ranging between 1 and The page number of results to return given the specified or default limit.
Returns An object with an array of results containing up to the limit and matching filters specified. Arguments id required ID of the product to delete.
Returns Returns the original product if the operation was successful, or null if the product was not found. Arguments name required Human-friendly name of the variant. Returns Returns a new variant if valid arguments are provided, otherwise returns an object containing validation errors. Arguments id required ID of the variant to retrieve. Returns Returns a variant if a valid ID was provided. Arguments id required Unique identifier for the variant. Returns Returns the updated variant if valid arguments are provided, otherwise returns an object containing validation errors.
Arguments id required ID of the variant to delete. Returns Returns the original variant if the operation was successful, or null if the variant was not found. Returns Returns a new stock adjustment if valid arguments are provided, otherwise returns an object containing validation errors. Arguments id required ID of the stock adjustment to retrieve.
Returns Returns a stock adjustment if a valid ID was provided. Indicates the category may be visible to customers, otherwise it will be hidden from view. A long form description of the category, often containing HTML or other markup. Expandable list of products as indexed and sorted by their respective position. Arguments name required A human-friendly name for the category.
Returns Returns a new category if valid arguments are provided, otherwise returns an object containing validation errors. Arguments id required ID of the category to retrieve. Returns Returns a category if a valid ID was provided. Arguments id required Unique identifier for the category. Returns Returns the updated category if valid arguments are provided, otherwise returns an object containing validation errors.
Arguments id required ID of the category to delete. Returns Returns the original category if the operation was successful, or null if the category was not found. Arguments id required Unique identifier for the attribute. Set true to make the attribute require a value when added to a product.
Set true to make the attribute visible to customers in a storefront. Returns Returns a new attribute if valid arguments are provided, otherwise returns an object containing validation errors.
Arguments id required ID of the attribute to retrieve. Returns Returns a attribute if a valid ID was provided. Returns Returns the updated attribute if valid arguments are provided, otherwise returns an object containing validation errors.
Arguments id required ID of the attribute to delete. Returns Returns the original attribute if the operation was successful, or null if the attribute was not found.
Add fields to standard models and create new ones to handle your unique content and business logic. Create sophisticated experiences fast with less resources. Start with a storefront theme and focus on what makes your business unique.
Increase revenue with native features like customer groups, subscriptions, and headless storefronts. Swell's autoscaling servers and global CDN mean you can grow faster with a small team at a fraction of the cost. Sell to retail and business customers from one catalog. Set up bulk pricing tiers and account-specific pricing. Developers can clone our storefronts, use their preferred stack, and have a Git-based workflow.
Connect payment gateways including Stripe, Braintree, and PayPal. Future-proof your business with headless ecommerce. Get started. Endless flexibility and customization. Modern dashboard Manage everything from our intuitive dashboard. Product modeling Configuring product options is fast and easy. Custom checkout Build completely custom checkout flows. Headless storefront themes Get all the benefits of headless, without starting from scratch.
Webhooks for everything Develop sophisticated applications based on system events, including on custom models. Fully managed infrastructure Our edge caching, global CDN, and auto-scaling API services adapt to handle busy promotional periods and bulk content updates.
0コメント