openapi: 3.0.3
servers:
- url: 'https://demo.spreecommerce.org'
description: demo
- url: 'http://localhost:3000'
description: localhost
info:
version: 2.0.0
title: Storefront API
description: |-
Storefront API is a modern REST API based on the [JSON API spec](https://jsonapi.org/) which provides you with all the necessary endpoints to build amazing user intefaces either in JavaScript frameworks or native mobile libraries.
Download [official JavaScript & TypeScript SDK](https://github.com/spree/spree-storefront-api-v2-js-sdk)
Import to [Postman](https://raw.githubusercontent.com/spree/spree/master/api/docs/v2/storefront/index.yaml)
contact:
name: Spark Solutions
url: 'https://sparksolutions.co'
email: we@sparksolutions.co
license:
name: BSD-3-Clause
url: 'https://github.com/spree/spree/blob/master/license.md'
paths:
/api/v2/storefront/account:
get:
description: Returns the current user details.
summary: Retrieve an Account
tags:
- Account
operationId: account-information
parameters:
- $ref: '#/components/parameters/AccountIncludeParam'
- $ref: '#/components/parameters/SparseFieldsUser'
responses:
'200':
$ref: '#/components/responses/User'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
post:
description: 'Creates a new account. This endpoint requires the [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem to be installed.'
summary: Create an Account
tags:
- Account
operationId: account-creation
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
user:
type: object
properties:
email:
type: string
example: john@snow.org
first_name:
type: string
example: John
last_name:
type: string
example: Snow
password:
type: string
example: spree123
password_confirmation:
type: string
example: spree123
public_metadata:
type: object
example:
user_segment: supplier
description: The public metadata for this User
private_metadata:
type: object
example:
has_abandoned_cart: false
description: The private metadata for this User
description: ''
responses:
'200':
$ref: '#/components/responses/User'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
patch:
description: 'Updates the users account details. This endpoint requires the [Spree Auth Devise](https://github.com/spree/spree_auth_devise) gem to be installed.'
summary: Update an Account
tags:
- Account
operationId: account-updates
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
user:
type: object
properties:
email:
type: string
example: john@snow.org
first_name:
type: string
example: John
last_name:
type: string
example: Snow
bill_address_id:
type: string
example: '1'
ship_address_id:
type: string
example: '1'
password:
type: string
example: spree123
password_confirmation:
type: string
example: spree123
responses:
'200':
$ref: '#/components/responses/User'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- bearerAuth: []
/api/v2/storefront/account/addresses:
get:
description: Returns a list of addresses for the current user.
summary: List all Addresses
operationId: addresses-list
responses:
'200':
$ref: '#/components/responses/AddressList'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/SparseFieldsAddress'
tags:
- Account / Address
post:
description: Creates a new address for the current user.
summary: Create an Address
tags:
- Account / Address
operationId: create-address
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
address:
$ref: '#/components/schemas/AddressPayload'
examples:
Create a Address:
value:
address:
firstname: Mark
lastname: Winterburn
company: Paper Street Soap Co.
address1: 775 Old Georgetown Road
address2: 3rd Floor
city: Qethesda
phone: '3488545445002'
zipcode: '90210'
state_name: CA
country_iso: US
label: Work
responses:
'200':
$ref: '#/components/responses/Address'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/SparseFieldsAddress'
'/api/v2/storefront/account/addresses/{id}':
delete:
description: This endpoint removes the specified address for the current user. It uses a soft delete to retain address information for pre-existing orders.
operationId: remove-address
responses:
'204':
description: 204 Success No Content Returned - Requested Address has been removed from the User Account
'404':
$ref: '#/components/responses/404NotFound'
security:
- bearerAuth: []
summary: Remove an Address
tags:
- Account / Address
patch:
description: Updates the specified address for the current user.
summary: Update an Address
operationId: update-address
parameters:
- $ref: '#/components/parameters/SparseFieldsAddress'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
address:
$ref: '#/components/schemas/AddressPayload'
examples:
Update an Address:
value:
address:
firstname: Stephen
lastname: Smith
company: Woodbank School
address1: 234 Old Georgetown Road
address2: 1st Floor
city: Aethesda
phone: '34885493845002'
zipcode: '90211'
state_name: CA
country_iso: US
label: Office
responses:
'200':
$ref: '#/components/responses/Address'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
tags:
- Account / Address
parameters:
- schema:
type: string
example: '1'
name: id
in: path
required: true
description: The ID of the specified `address`.
/api/v2/storefront/account/credit_cards:
get:
description: Returns a list of credit cards for the current user.
summary: List all Credit Cards
operationId: credit-cards-list
responses:
'200':
$ref: '#/components/responses/CreditCardList'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
parameters:
- in: query
name: 'filter[payment_method_id]'
schema:
type: string
example: '2'
description: Filter based on payment method ID
- $ref: '#/components/parameters/CreditCardIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCreditCard'
tags:
- Account / Credit Cards
'/api/v2/storefront/account/credit_cards/{id}':
delete:
description: Removes a specified credit card for the current user with a soft delete to retain payment information for any pre-existing orders.
operationId: remove-credit-card
responses:
'204':
description: 204 Success No Content Returned - Requested Credit Card has been removed from the User Account
'404':
$ref: '#/components/responses/404NotFound'
security:
- bearerAuth: []
summary: Remove a Credit Card
tags:
- Account / Credit Cards
parameters:
- schema:
type: string
example: '1'
name: id
in: path
required: true
description: The ID of the `credit_card` you wish to remove.
/api/v2/storefront/account/credit_cards/default:
get:
description: Returns the current user's default credit card.
summary: Retrieve the default Credit Card
operationId: default-credit-card
responses:
'200':
$ref: '#/components/responses/CreditCard'
'403':
$ref: '#/components/responses/403Forbidden'
parameters:
- $ref: '#/components/parameters/CreditCardIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCreditCard'
security:
- bearerAuth: []
tags:
- Account / Credit Cards
/api/v2/storefront/account/orders:
get:
description: Returns all completed orders placed by the current user in the current store.
summary: List all Orders
operationId: completed-orders
responses:
'200':
$ref: '#/components/responses/CartList'
'403':
$ref: '#/components/responses/403Forbidden'
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
security:
- bearerAuth: []
tags:
- Account / Orders
'/api/v2/storefront/account/orders/{order_number}':
get:
description: Returns a completed order for the current user within the scope of the current store.
summary: Retrieve an Order
operationId: completed-user-order
responses:
'200':
$ref: '#/components/responses/Cart'
'403':
$ref: '#/components/responses/403Forbidden'
parameters:
- $ref: '#/components/parameters/OrderParam'
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
security:
- bearerAuth: []
tags:
- Account / Orders
parameters:
- $ref: '#/components/parameters/OrderParam'
'/api/v2/storefront/order_status/{order_number}':
get:
description: |-
Returns completed order information.
This endpoint is useful when fetching orders placed by a guest user, allowing customers without an account to check the status of their order: (shipment/payment/processing) etc.
Pass the cart `token` value as the `X-Spree-Order-Token` for authorization, and the corresponding cart `number` in the URI **{order_number}** to successfully retrieve an order.
summary: Retrieve an Order Status
operationId: order-status
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
security:
- orderToken: []
tags:
- Order Status
parameters:
- $ref: '#/components/parameters/OrderParam'
/api/v2/storefront/cart:
post:
description: |-
Creates a new cart.
**Please be aware**; The `token` value found in the response body is used to authorize all future operations on this cart through the Auth API Key `X-Spree-Order-Token`.
tags:
- Cart
operationId: create-cart
responses:
'201':
$ref: '#/components/responses/Cart'
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
requestBody:
required: false
content:
application/vnd.api+json:
schema:
type: object
example:
public_metadata:
total_weight: 3250
private_metadata:
had_same_cart_items: true
properties:
public_metadata:
type: object
description: The public metadata for the cart.
private_metadata:
type: object
description: The private metadata for the cart.
summary: Create a Cart
delete:
description: |-
Deletes a specified cart.
When this endpoint is successfully executed, all shipments are cancelled, payments are voided, then line items, shipments & payments are all deleted.
tags:
- Cart
operationId: deletes-cart
responses:
'204':
description: 204 Success No Content Returned - Current Cart has been removed.
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
summary: Delete a Cart
get:
description: Returns the cart for the current user.
tags:
- Cart
operationId: get-cart
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
- $ref: '#/components/parameters/CartCurrencyParam'
summary: Retrieve a Cart
/api/v2/storefront/cart/add_item:
post:
description: Adds a variant to the current cart by creating a line item. Each line item represents a specified variant and the desired quantity.
operationId: add-item
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
example:
variant_id: '1'
quantity: 5
public_metadata:
first_item_order: true
private_metadata:
recommended_by_us: false
properties:
variant_id:
type: string
quantity:
type: integer
public_metadata:
type: object
description: The public metadata for the added item.
private_metadata:
type: object
description: The private metadata for the added item.
options:
type: object
description: 'Additional custom options. Activate these by adding: `Spree::PermittedAttributes.line_item_attributes << :foo` in `config/initializers/spree.rb`'
description: |-
Additional parameters can be passed in the **options** hash. Each custom parameter must be registered in `config/initializers/spree.rb`, eg.
```ruby
Spree::PermittedAttributes.line_item_attributes << :foo
```
summary: Add an Item to Cart
tags:
- Cart / Line Items
/api/v2/storefront/cart/set_quantity:
patch:
description: Sets the quantity of a specified line item.
operationId: set-quantity
responses:
'200':
$ref: '#/components/responses/Cart'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
line_item_id:
type: string
quantity:
type: integer
example:
line_item_id: '1'
quantity: 5
description: The quantity has to be a positive integer greater than 0.
summary: Set Line Item Quantity
tags:
- Cart / Line Items
'/api/v2/storefront/cart/remove_line_item/{id}':
delete:
description: |-
Removes a line item from the cart by deleting the line item.
After deleting the line item, the system will re-calculate taxes, promotions, shipments etc.
operationId: remove-line-item
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
summary: Remove a Line Item
tags:
- Cart / Line Items
parameters:
- schema:
type: string
example: '1'
name: id
in: path
required: true
description: The ID of the `line_item` you wish to remove.
/api/v2/storefront/cart/empty:
patch:
description: This endpoint removed all line items from the cart. Inventory that was previously taken by this order will be re-stocked.
operationId: empty-cart
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
summary: Empty the Cart
tags:
- Cart / Other
/api/v2/storefront/cart/apply_coupon_code:
patch:
description: Applies a coupon code to the current cart.
operationId: apply-coupon-code
responses:
'200':
$ref: '#/components/responses/Cart'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
coupon_code:
type: string
example: DISCOUNT10
summary: Apply a Coupon Code
tags:
- Cart / Coupons
'/api/v2/storefront/cart/remove_coupon_code/{coupon_code}':
delete:
description: Removes a specified coupon code from the current cart.
operationId: remove-coupon-code
parameters:
- name: coupon_code
in: path
required: true
description: Specify the coupon code for removal.
schema:
type: string
example: DISCOUNT10
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
responses:
'200':
$ref: '#/components/responses/Cart'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
summary: Remove a Coupon
tags:
- Cart / Coupons
/api/v2/storefront/cart/remove_coupon_code:
delete:
description: Removes all coupons that have been applied to the current cart.
operationId: remove-all-coupon-codes
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
responses:
'200':
$ref: '#/components/responses/Cart'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
summary: Remove all Coupons
tags:
- Cart / Coupons
/api/v2/storefront/cart/estimate_shipping_rates:
get:
description: Returns a list of shipping rates for the current cart. The rates given are only estimates and can vary from the final shipping rates.
operationId: estimate-shipping-rates
parameters:
- name: country_iso
in: query
description: Pass country ISO or ISO3 symbol to get estimations for this destination. If no code is passed we'll try to use Cart shipping address country or the default Country for the current Store.
schema:
type: string
example: USA
example: USA
required: true
- $ref: '#/components/parameters/SparseFieldsShippingRate'
responses:
'200':
$ref: '#/components/responses/EstimatedShippingRates'
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
summary: List Estimated Shipping Rates
tags:
- Cart / Other
/api/v2/storefront/cart/associate:
patch:
description: Associates a guest cart with the currently signed in user.
operationId: associate-cart
parameters:
- name: guest_order_token
in: query
description: Token of the guest cart to be associated with user.
schema:
type: string
example: bd7SHdOAQqTsQHsjnhoWIw1633364692479
required: true
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
responses:
'200':
$ref: '#/components/responses/Cart'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- bearerAuth: []
summary: Associate a Cart with a User
tags:
- Cart / Other
/api/v2/storefront/cart/change_currency:
patch:
description: Changes the cart currency and recalculates the cart values.
operationId: change-currency
parameters:
- name: new_currency
in: query
description: The currency to change the cart to.
schema:
type: string
example: USD
required: true
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
responses:
'200':
$ref: '#/components/responses/Cart'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- bearerAuth: []
summary: Change Cart Currency
tags:
- Cart / Other
/api/v2/storefront/checkout:
patch:
description: The Update Checkout endpoint allows you to manage the typical stages of an e-commerce checkout system.
tags:
- Checkout
operationId: update-checkout
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
summary: Update Checkout
requestBody:
content:
application/vnd.api+json:
schema:
type: object
properties:
order:
type: object
properties:
email:
type: string
example: john@snow.org
bill_address_attributes:
$ref: '#/components/schemas/AddressPayload'
ship_address_attributes:
$ref: '#/components/schemas/AddressPayload'
shipments_attributes:
type: array
items:
type: object
properties:
id:
type: string
example: '3'
description: The Shipment `id`
selected_shipping_rate_id:
type: string
example: '10'
description: The Shipping Rate `id`
required:
- id
- selected_shipping_rate_id
payments_attributes:
type: array
items:
type: object
properties:
payment_method_id:
type: string
example: '1'
description: The `id` of the Payment Method
source_attributes:
type: object
properties:
gateway_payment_profile_id:
type: string
month:
type: number
year:
type: number
cc_type:
type: string
name:
type: string
required:
- payment_method_id
- source_attributes
examples:
Add Customer Details:
value:
order:
email: john@snow.org
bill_address_attributes:
firstname: John
lastname: Snow
address1: 7735 Old Georgetown Road
city: Bethesda
phone: '3014445002'
zipcode: '20814'
state_name: MD
country_iso: US
ship_address_attributes:
firstname: John
lastname: Snow
address1: 7735 Old Georgetown Road
city: Bethesda
phone: '3014445002'
zipcode: '20814'
state_name: MD
country_iso: US
Add Shipping Rates:
value:
order:
shipments_attributes:
- id: '1'
selected_shipping_rate_id: '1'
Add a Payment:
value:
order:
payments_attributes:
- payment_method_id: '1'
source_attributes:
gateway_payment_profile_id: ABC123
cc_type: visa
last_digits: '1111'
month: 10
year: 2022
name: John Doe
description: |-
##### Add Customer Details
Adding customer details is achieved by passing the customer-related attributes shown in the corresponding request body example.
##### Add Shipping Rates
To add shipping rates, you will need a shipment associated with the checkout. If you do not have any shipments follow the steps below:
1. First, ensure your cart has items added via the **Add an Item to Cart** endpoint.
2. Next, ensure the checkout has a shipping address set, you can set this by running the *Add Customer Details* example above.
3. Next run the **Advance Checkout** endpoint, this will create shipments for the items in the cart and users shipping destination.
Use the **List Shipping Rates** endpoint to find the shipments and shipping rates available for this checkout. Note the shipment `id` and shipping_rate `id`; use these values to populate your request body.
##### Add a Payment
To add a payment method, you must find the available payment methods by running the **List Payment Methods** endpoint, each payment method has its own set of source attribute requirements. In the example shown, we have used the source attributes for a card payment.
Pass the `payment_method_id` and `source_attribute` hash containing the required attributes for the selected payment method.
/api/v2/storefront/checkout/next:
patch:
description: Goes to the next checkout step.
operationId: checkout-next
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
summary: Next Checkout Step
tags:
- Checkout / State
/api/v2/storefront/checkout/advance:
patch:
description: 'Advances the checkout to the furthest checkout step validation allows, up until the **completed** step.'
operationId: advance-checkout
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
summary: Advance Checkout
tags:
- Checkout / State
/api/v2/storefront/checkout/complete:
patch:
description: |-
Completes the checkout by marking the order as complete.
**Please be aware**; Once a checkout is marked as `complete` it is considered a completed order, the Cart and Checkout endpoints will no longer access a completed order, and a new cart will need to be created.
If you want to access a completed order you will need to use the **Account / Orders** or **Order Status** endpoints.
operationId: complete-checkout
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
summary: Complete Checkout
tags:
- Checkout / State
/api/v2/storefront/checkout/select_shipping_method:
patch:
description: |-
Selects shipping method for Shipment(s).
To generate shipments you first need to fetch shipping rates via
[Get Shipping Rates](https://api.spreecommerce.org/docs/api-v2/b3A6MzE0Mjc2MQ-list-shipping-rates) endpoint
operationId: select-shipping-method
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
requestBody:
content:
application/vnd.api+json:
schema:
type: object
properties:
shipping_method_id:
type: string
description: ID of the selected Shipping Method
shipment_id:
type: string
description: ID of the selected Shipment. If not supplied it will try to set selected shipping method for all shipments
required:
- shipping_method_id
examples:
Set shippng method for all shipments:
value:
shipping_method_id: '1'
Set shipping method for specific shipment:
value:
shipping_method_id: '1'
shipment_id: '1'
description: ''
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
summary: Selects shipping method for shipment(s)
tags:
- Checkout / Shipments
/api/v2/storefront/checkout/create_payment:
post:
description: |-
Creates new Payment for the current checkout.
You can either create new payment source (eg. a Credit Card) or use an existing (for signed in users only).
Newly created payment source will be associated to the current signed in user.
System will automatically invalidate previous (non-finalized) payments (excluding store credit / gift card payments).
[More details on payment system](https://dev-docs.spreecommerce.org/internals/payments)
operationId: create-payment
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
requestBody:
content:
application/vnd.api+json:
schema:
type: object
properties:
payment_method_id:
type: string
description: ID of the selected Payment Method
source_id:
type: string
description: 'ID of the selected Payment Source (eg. Credit Card, only for signed in users)'
amount:
type: number
description: 'Amount for the newly created payment, when left blank will use the entire Order Total (reduced by used Store Credits / Gift Cards)'
source_attributes:
type: object
properties:
gateway_payment_profile_id:
type: string
description: 'Payment source authorization token, more details for [Stripe implementation](https://stripe.com/docs/payments/accept-a-payment-charges#web-create-token)'
cc_type:
type: string
enum:
- visa
- mastercard
- amex
last_digits:
type: string
description: Last 4 digits of CC number
month:
type: number
description: Expiration date month
year:
type: number
description: Expiration date year
name:
type: string
description: Card holder name
required:
- gateway_payment_profile_id
- name
required:
- payment_method_id
examples:
Create new Credit Card:
value:
payment_method_id: '1'
source_attributes:
gateway_payment_profile_id: card_1JqvNB2eZvKYlo2C5OlqLV7S
cc_type: visa
last_digits: '1111'
month: 10
year: 2026
name: John Snow
Use existing Credit Card:
value:
payment_method_id: '1'
source_id: '1'
description: ''
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
summary: Create new Payment
tags:
- Checkout / Payments
/api/v2/storefront/checkout/add_store_credit:
post:
description: |-
The Add Store Credit endpoint takes the users existing store credit from their account and adds a set amount of this store credit to the current cart.
In essence, by adding the user's store credit to a cart, the user's store credit is being spent.
operationId: add-store-credit
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- in: query
name: amount
description: Amount of Store Credit to use. As much as possible Store Credit will be applied if no amount is passed.
schema:
type: string
example: '100'
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
summary: Add Store Credit
tags:
- Checkout / Store Credit
/api/v2/storefront/checkout/remove_store_credit:
post:
description: Removes store credit from the cart if any had previously been applied.
operationId: remove-store-credit
responses:
'200':
$ref: '#/components/responses/Cart'
'404':
$ref: '#/components/responses/404NotFound'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- orderToken: []
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/CartIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCart'
summary: Remove Store Credit
tags:
- Checkout / Store Credit
/api/v2/storefront/checkout/payment_methods:
get:
description: Returns a list of available payment methods for this checkout.
tags:
- Checkout / Payments
operationId: payment-methods
responses:
'200':
$ref: '#/components/responses/PaymentMethodList'
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
summary: List Payment Methods
/api/v2/storefront/checkout/shipping_rates:
get:
description: |-
Returns a list of available shipping rates for the checkout.
Shipping rates are grouped against shipments. Each checkout can have multiple shipments. Some products are in stock and will be shipped immediately, while others might be back-ordered and sent later.
tags:
- Checkout / Shipments
operationId: shipping-rates
responses:
'200':
$ref: '#/components/responses/Shipment'
'404':
$ref: '#/components/responses/404NotFound'
security:
- orderToken: []
- bearerAuth: []
summary: List Shipping Rates
/api/v2/storefront/products:
get:
description: Returns a list of products for the current Store.
tags:
- Products
operationId: products-list
parameters:
- $ref: '#/components/parameters/FilterByIds'
- $ref: '#/components/parameters/FilterBySKUs'
- in: query
name: 'filter[price]'
schema:
type: string
example: '10,100'
description: 'Filter Products based on price (minimum, maximum range)'
- in: query
name: 'filter[taxons]'
schema:
type: string
example: '1,2,3,4,5,6,7,8,9,10,11'
description: 'Filter Products based on taxons (IDs of categories, brands, etc)'
- in: query
name: 'filter[name]'
schema:
type: string
example: rails
description: 'Find Products with matching name (supports wild-card, partial-word match search)'
- in: query
name: 'filter[options][tshirt-color]'
schema:
type: string
example: Red
description: 'Find Products with Variants that have the specified option (eg. color, size) and value (eg. red, XS)'
- in: query
name: 'filter[properties][brand-name]'
schema:
type: string
example: alpha
description: Find Products with Property Brand Name with value Alpha
- in: query
name: 'filter[show_deleted]'
schema:
type: boolean
example: true
description: Returns also deleted products
- in: query
name: 'filter[show_discontinued]'
schema:
type: boolean
example: true
description: Returns also discontinued products
- in: query
name: 'filter[in_stock]'
schema:
type: boolean
example: true
description: Returns only in stock products
- in: query
name: 'filter[backorderable]'
schema:
type: boolean
example: true
description: Returns only backorderable products
- in: query
name: 'filter[purchasable]'
schema:
type: boolean
example: true
description: Returns only in stock or backorderable products
- in: query
name: sort
schema:
type: string
example: '-updated_at,price,-name,created_at,-available_on,sku'
description: |-
Sort products based on:
- name (ascending/descending)
- price (ascending/descending)
- available_on (ascending/descending)
- created_at (ascending/descending)
- updated_at (ascending/descending)
- sku (ascending/descending)
Use -
sign to set descending sort, eg. -updated_at
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/ProductIncludeParam'
- $ref: '#/components/parameters/SparseFieldsProduct'
- $ref: '#/components/parameters/ProductImageTransformationSizeParam'
- $ref: '#/components/parameters/ProductImageTransformationQualityParam'
responses:
'200':
$ref: '#/components/responses/ProductList'
summary: List all Products
'/api/v2/storefront/products/{product_slug}':
get:
description: |-
Returns Product details. You can use product permalink:
```
GET /api/v2/storefront/products/knitted-high-neck-sweater
```
Or Product ID:
```
GET /api/v2/storefront/products/21
```
**Note** API will attempt a permalink lookup before an ID lookup.
tags:
- Products
operationId: show-product
parameters:
- $ref: '#/components/parameters/ProductSlug'
- $ref: '#/components/parameters/ProductIncludeParam'
- $ref: '#/components/parameters/SparseFieldsProduct'
- $ref: '#/components/parameters/ProductImageTransformationSizeParam'
- $ref: '#/components/parameters/ProductImageTransformationQualityParam'
responses:
'200':
$ref: '#/components/responses/Product'
'404':
$ref: '#/components/responses/404NotFound'
summary: Retrieve a Product
/api/v2/storefront/store:
get:
summary: Return the current Store
description: 'Returns the current Store. [Read more about Stores](https://dev-docs.spreecommerce.org/internals/stores)'
tags:
- Stores
operationId: show-current-store
parameters:
- $ref: '#/components/parameters/StoreIncludeParam'
- $ref: '#/components/parameters/SparseFieldsStore'
responses:
'200':
$ref: '#/components/responses/Store'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
/api/v2/storefront/taxons:
get:
description: 'Returns a list of Taxons. [Read more about Taxons](https://dev-docs.spreecommerce.org/internals/products#taxons-and-taxonomies)'
tags:
- Taxons
operationId: taxons-list
parameters:
- $ref: '#/components/parameters/FilterByIds'
- $ref: '#/components/parameters/FilterByName'
- in: query
name: 'filter[parent_id]'
schema:
type: string
example: '1'
description: Fetch children nodes of specified Taxon
- in: query
name: 'filter[parent_permalink]'
schema:
type: string
example: clothes
description: Fetch children nodes of specified Taxon permalink
- in: query
name: 'filter[taxonomy_id]'
schema:
type: string
example: '1'
description: Fetch Taxons in a specified Taxonomy
- in: query
name: 'filter[roots]'
schema:
type: boolean
example: false
description: Fetch only root Taxons (Taxonomies)
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/TaxonIncludeParam'
- $ref: '#/components/parameters/SparseFieldsTaxon'
responses:
'200':
$ref: '#/components/responses/TaxonList'
summary: List all Taxons
'/api/v2/storefront/taxons/{taxon_permalink}':
get:
description: Returns the details of a specified taxon.
tags:
- Taxons
operationId: show-taxon
parameters:
- $ref: '#/components/parameters/TaxonPermalink'
- $ref: '#/components/parameters/TaxonIncludeParam'
- $ref: '#/components/parameters/SparseFieldsTaxon'
responses:
'200':
$ref: '#/components/responses/Taxon'
'404':
$ref: '#/components/responses/404NotFound'
summary: Retrieve a Taxon
/api/v2/storefront/countries:
get:
description: Returns a list of all countries.
tags:
- Countries
operationId: countries-list
responses:
'200':
$ref: '#/components/responses/CountryList'
summary: List all Countries
'/api/v2/storefront/countries/{iso}':
get:
description: Returns the details of a specific country.
tags:
- Countries
operationId: show-country
parameters:
- $ref: '#/components/parameters/IsoOrIso3'
- $ref: '#/components/parameters/CountryIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCountry'
responses:
'200':
$ref: '#/components/responses/Country'
'404':
$ref: '#/components/responses/404NotFound'
summary: Retrieve a Country
/api/v2/storefront/countries/default:
get:
description: Returns the default country for the current store. By default this will be the US.
tags:
- Countries
operationId: default-country
parameters:
- $ref: '#/components/parameters/CountryIncludeParam'
- $ref: '#/components/parameters/SparseFieldsCountry'
responses:
'200':
$ref: '#/components/responses/Country'
summary: Get Default Country
/api/v2/storefront/cms_pages:
get:
description: Returns a list of all CMS Pages available in the current store.
tags:
- CMS Pages
operationId: get-cms-pages
parameters:
- $ref: '#/components/parameters/FilterByType'
- $ref: '#/components/parameters/FilterByTitle'
- $ref: '#/components/parameters/CmsPageIncludeParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
$ref: '#/components/responses/CmsPageList'
'404':
$ref: '#/components/responses/404NotFound'
summary: List all CMS Pages
'/api/v2/storefront/cms_pages/{cms_page_slug}':
get:
description: |-
To return a single CMS Page you can use the CMS Page slug:
```
GET /api/v2/storefront/cms_pages/about-us
```
or CMS Page ID:
```
GET /api/v2/storefront/cms_pages/37
```
**Note:** API will attempt a Slug lookup before an ID lookup.
tags:
- CMS Pages
operationId: get-cms-page
parameters:
- $ref: '#/components/parameters/CmsPageSlug'
- $ref: '#/components/parameters/CmsPageIncludeParam'
responses:
'200':
$ref: '#/components/responses/CmsPage'
'404':
$ref: '#/components/responses/404NotFound'
summary: Retrieve a CMS Page
/api/v2/storefront/menus:
get:
description: Returns a list of all menus available in the current store.
tags:
- Menus
operationId: get-menus
parameters:
- $ref: '#/components/parameters/FilterByLocation'
- $ref: '#/components/parameters/MenuIncludeParam'
- $ref: '#/components/parameters/LocaleParam'
- $ref: '#/components/parameters/PerPageParam'
responses:
'200':
$ref: '#/components/responses/MenuList'
'404':
$ref: '#/components/responses/404NotFound'
summary: List all Menus
'/api/v2/storefront/menus/{id}':
get:
description: Returns the dertails of a specified menu.
tags:
- Menus
operationId: get-menu
parameters:
- $ref: '#/components/parameters/MenuIncludeParam'
responses:
'200':
$ref: '#/components/responses/Menu'
'404':
$ref: '#/components/responses/404NotFound'
summary: Retrieve a Menu
parameters:
- schema:
type: string
example: '1'
name: id
in: path
required: true
description: The ID of the `menu` you wish to retrieve.
/api/v2/storefront/wishlists:
get:
description: 'Returns all wishlists available to the current user, in the current store.'
summary: List all Wishlists
tags:
- Wishlists
operationId: list-wishlists-for-current-user
parameters:
- $ref: '#/components/parameters/WishlistIncludeParam'
- $ref: '#/components/parameters/SparseFieldsWishlist'
- $ref: '#/components/parameters/PerPageParam'
- $ref: '#/components/parameters/WishlistIsVariantIncludedParam'
responses:
'200':
$ref: '#/components/responses/WishlistList'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
post:
description: Creates a new wishlist for the current user in the current store.
summary: Create a Wishlist
tags:
- Wishlists
operationId: create-wishlist
responses:
'200':
$ref: '#/components/responses/Wishlist'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The Wishlist name.
is_private:
type: boolean
description: Set the Wishlist to public or private. Defaults to true (private).
is_default:
type: boolean
description: Whether the wishlist is set to the users default wishlist for the current store. Defaults to false.
required:
- name
examples:
Create wishlist:
value:
name: My Wishlist
is_private: false
is_default: true
parameters:
- $ref: '#/components/parameters/SparseFieldsWishlist'
'/api/v2/storefront/wishlists/{token}':
get:
description: |-
Retrieves a wishlist using the wishlist token.
If the wishlist is publicly viewable, the endpoint will return the requested wishlist regardless of the user. If the wishlist is private, only the wishlist owner can access the wishlist.
summary: Retrieve a Wishlist
tags:
- Wishlists
operationId: get-wishlist-details
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/WishlistIncludeParam'
- $ref: '#/components/parameters/SparseFieldsWishlist'
- $ref: '#/components/parameters/WishlistIsVariantIncludedParam'
responses:
'200':
$ref: '#/components/responses/Wishlist'
'403':
$ref: '#/components/responses/403Forbidden'
patch:
description: Updates the specific Wishlist by setting the values passed in the request body. Any parameters not provided will be left unchanged.
summary: Update a Wishlist
tags:
- Wishlists
operationId: update-wishlist
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
wishlist:
type: object
properties:
name:
type: string
description: Change the wishlist name.
is_private:
type: boolean
description: Set the wishlist to public or private.
is_default:
type: boolean
description: Make this wishlist the default wishlist.
examples:
Update Name:
value:
wishlist:
name: Birthday Ideas
Set to Private:
value:
wishlist:
is_private: true
Make Default:
value:
wishlist:
is_default: true
description: ''
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/SparseFieldsWishlist'
responses:
'200':
$ref: '#/components/responses/Wishlist'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- bearerAuth: []
delete:
description: This operation deletes the wishlist identified in the URI `token`.
summary: Delete a Wishlist
tags:
- Wishlists
operationId: delete-wishlist
parameters:
- $ref: '#/components/parameters/Token'
responses:
'204':
description: 204 Success - No Content
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
/api/v2/storefront/wishlists/default:
get:
description: 'Returns the default wishlist for the current user, in the current store. If the user does not have a default wishlist in the current store one will be created.'
summary: Retrieve the default Wishlist
tags:
- Wishlists
operationId: get-default-wishlist
parameters:
- $ref: '#/components/parameters/WishlistIncludeParam'
- $ref: '#/components/parameters/SparseFieldsWishlist'
- $ref: '#/components/parameters/WishlistIsVariantIncludedParam'
responses:
'200':
$ref: '#/components/responses/Wishlist'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
'/api/v2/storefront/wishlists/{token}/add_item':
post:
summary: Add Item to Wishlist
description: |-
The Add Item to Wishlist endpoint adds a variant to an existing wishlist by creating a new `wished_item`. A wished item in a wishlist is comparable to a line item in a cart.
Each wished item references a single variant, holds the desired quantity and returns price information determined by the variant price in current currency, and desired quantity.
operationId: add-item-to-wishlist
parameters:
- $ref: '#/components/parameters/Token'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
variant_id:
type: string
description: The variant ID that is to be added to the wishlist.
quantity:
type: number
description: 'Set a quantity greater than 0, or omit the quantity param if your wishlist does not support quantities.'
required:
- variant_id
examples:
Add a variant:
value:
variant_id: '149'
quantity: 3
description: |-
Passing a quantity value is optional for those wishlist systems that do not support quantities. In this scenario, the returned quantity value will always be `1`, allowing the add-to-cart and pricing to reflect the single representation of the wished item accurately.
If the wishlist system you are building allows for setting quantity, add the quantity attribute to the request body with an integer value greater than zero.
responses:
'200':
$ref: '#/components/responses/WishedItem'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- bearerAuth: []
tags:
- Wishlists / Wished Items
parameters:
- schema:
type: string
name: token
in: path
required: true
'/api/v2/storefront/wishlists/{token}/set_item_quantity/{item_id}':
patch:
description: This endpoint sets the wished item quantity.
summary: Set Wished Item Quantity
operationId: update-wished-variant-quantity
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/ItemId'
requestBody:
required: true
content:
application/vnd.api+json:
schema:
type: object
properties:
quantity:
type: number
description: Set the quantity value to an integer greater than 0
required:
- quantity
examples:
Add a variant:
value:
quantity: 7
description: ''
responses:
'200':
$ref: '#/components/responses/WishedItem'
'403':
$ref: '#/components/responses/403Forbidden'
'422':
$ref: '#/components/responses/422UnprocessableEntity'
security:
- bearerAuth: []
tags:
- Wishlists / Wished Items
'/api/v2/storefront/wishlists/{token}/remove_item/{item_id}':
delete:
description: Removes a wished item from a wishlist.
summary: Delete Item from Wishlist
operationId: delete-wished-variant-from-wishlist
parameters:
- $ref: '#/components/parameters/Token'
- $ref: '#/components/parameters/ItemId'
responses:
'200':
$ref: '#/components/responses/WishedItem'
'403':
$ref: '#/components/responses/403Forbidden'
security:
- bearerAuth: []
tags:
- Wishlists / Wished Items
parameters:
- schema:
type: string
name: token
in: path
required: true
- schema:
type: string
name: item_id
in: path
required: true
'/api/v2/storefront/digitals/{token}':
get:
summary: Download a Digital Asset
tags:
- Digital Downloads
responses:
'200':
description: 200 Success - Returns the digital asset.
content:
image/jpeg:
schema:
type: object
format: binary
image/gif:
schema:
type: object
format: binary
image/svg+xml:
schema:
type: object
format: binary
image/bmp:
schema:
type: object
format: binary
image/tiff:
schema:
type: object
format: binary
image/png:
schema:
type: object
format: binary
video/mpeg:
schema:
type: object
format: binary
application/gzip:
schema:
type: object
format: binary
application/zip:
schema:
type: object
format: binary
application/pdf:
schema:
type: object
format: binary
font/woff:
schema:
type: object
format: binary
font/woff2:
schema:
type: object
format: binary
font/otf:
schema:
type: object
format: binary
font/ttf:
schema:
type: object
format: binary
text/plain:
schema:
type: object
format: binary
'403':
$ref: '#/components/responses/403Forbidden'
operationId: get-digitals
description: |-
This endpoint allows you to download a digital item using the unique digital_link token.
The digital_link token value can be found by including `line_items.digital_links` in a completed order lookup.
Use the **Retrieve an Order Status** endpoint found under the Order Status tab, or the **Retrieve an Order** endpoint found under the Account / Orders tab to perform a completed order lookup.
Depending on the store that the item was purchased in, downloads may be restricted to a set number of days since the purchase was made. Additionally, the number of times a download link can be used may be restricted.
If you are not authorized to perform the download due to the download limit restrictions mentioned above, a 403 response will be returned.
parameters:
- schema:
type: string
example: 4WaA5vjMbnivskav2rMPGKzt
name: token
in: path
required: true
description: Use the token from the digital link.
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: |-
User token to authorize Cart and Checkout requests.
You can obtain it from [/spree_oauth/token](../../oauth/index.yml) endpoint.
It is required to associate Cart with the User.
orderToken:
type: apiKey
in: header
description: |-
Order token to authorize Cart and Checkout requests.
Useful for guest checouts when you don't have the user token (bearerAuth)
You can obtain it from the [/cart](index.yaml/paths/~1cart/post) endpoint - it's part of the response (value of the `token` attribute).
name: X-Spree-Order-Token
schemas:
Address:
type: object
title: Address
description: 'The Address model holds the customer details, such as name, address, and phone number.'
properties:
id:
type: string
example: '1'
type:
type: string
default: address
attributes:
type: object
properties:
firstname:
type: string
example: John
lastname:
type: string
example: Doe
address1:
type: string
example: 1600 Amphitheatre Pkwy
address2:
type: string
example: Suite 1
nullable: true
city:
type: string
example: Mountain View
zipcode:
type: string
example: '94043'
phone:
type: string
example: (+1) 123 456 789
nullable: true
state_name:
type: string
example: California
state_code:
type: string
example: CA
description: State abbreviation
nullable: true
country_name:
type: string
example: United States of America
country_iso3:
type: string
example: USA
description: Country ISO3 code
company:
type: string
example: Google Inc.
description: Company name
nullable: true
label:
type: string
description: 'The internal name for this address (Work, Home)'
example: Home
nullable: true
required:
- id
- type
- attributes
x-internal: true
AddressPayload:
example:
firstname: John
lastname: Snow
address1: 7735 Old Georgetown Road
address2: 2nd Floor
city: Bethesda
phone: '3014445002'
zipcode: '20814'
state_name: MD
country_iso: US
type: object
x-internal: true
title: ''
x-examples: {}
description: ''
properties:
firstname:
type: string
lastname:
type: string
address1:
type: string
description: Street address
address2:
type: string
description: 'Additional address information, floor no etc'
city:
type: string
description: 'City, town'
phone:
type: string
zipcode:
type: string
description: 'Valid zipcode, will be validated against the selected Country'
state_name:
type: string
description: State/region/province 2 letter abbreviation
country_iso:
type: string
description: 'Country ISO (2-chars) or ISO3 (3-chars) code. [List of all codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)'
company:
type: string
example: Paper Street Soap Co.
description: Company name
label:
type: string
example: Work
description: 'The internal name for this address (Work, Home)'
required:
- firstname
- lastname
- address1
- city
- country_iso
Cart:
description: 'The Cart provides a central place to collect information about an order, including line items, adjustments, payments, addresses, and shipments. [Read more in Spree docs](https://dev-docs.spreecommerce.org/internals/orders)'
type: object
title: Cart
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: cart
attributes:
type: object
properties:
number:
type: string
example: R123456789
description: 'Used as the **{order_number}** value in the URI to identify a completed order.'
token:
type: string
example: eL0nVxe1Aum-Qr9-UkryPA1633360128076
description: Used for authorizing actions through the `X-Spree-Order-Token` API Key.
item_total:
type: string
example: '19.99'
total:
type: string
example: '29.99'
ship_total:
type: string
example: '0.0'
adjustment_total:
type: string
example: '10.0'
created_at:
$ref: '#/components/schemas/Timestamp'
updated_at:
$ref: '#/components/schemas/Timestamp'
completed_at:
type: string
format: date-time
nullable: true
included_tax_total:
type: string
example: '5.00'
additional_tax_total:
type: string
example: '5.0'
display_additional_tax_total:
type: string
example: $5.00
tax_total:
type: string
example: '10.0'
currency:
type: string
example: USD
state:
type: string
example: cart
enum:
- cart
- address
- delivery
- payment
- confirm
- complete
description: |-
State of the Cart in the Checkout flow. Please see
The Order State machine
for a full list with description.
email:
type: string
format: email
example: spree@example.com
nullable: true
display_item_total:
type: string
example: $19.99
display_ship_total:
type: string
example: $19.99
display_adjustment_total:
type: string
example: $10.00
display_included_tax_total:
type: string
example: $5.00
promo_total:
type: string
example: '-10.0'
display_promo_total:
type: string
example: '-$10.00'
item_count:
type: number
description: Total quantity number of all items added to the Cart
example: 2
minimum: 0
special_instructions:
type: string
example: Please wrap it as a gift
description: Message added by the Customer
nullable: true
display_total:
type: string
example: $29.99
pre_tax_item_amount:
type: string
example: '17.00'
display_pre_tax_item_amount:
type: string
example: $17.00
pre_tax_total:
type: string
example: '20.00'
display_tax_total:
type: string
example: $10.00
display_pre_tax_total:
type: string
example: $20.00
shipment_state:
type: string
enum:
- pending
- backorder
- canceled
- partial
- ready
- shipped
- null
description: |-
Overall state of the Shipments. Please see
Order Shipments states
for a full list with description.
nullable: true
payment_state:
type: string
enum:
- balance_due
- credit_owed
- failed
- paid
- void
- null
description: |-
Overall state of the Payments. Please see
Order Payments states
for a full list with description.
nullable: true
relationships:
type: object
properties:
line_items:
type: object
description: ''
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
variants:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
promotions:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
payments:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
shipments:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
user:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
billing_address:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
shipping_address:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
CartIncludes:
x-internal: true
title: Cart Includes
anyOf:
- $ref: '#/components/schemas/LineItem'
- $ref: '#/components/schemas/Promotion'
- $ref: '#/components/schemas/Variant'
- $ref: '#/components/schemas/Payment'
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/Shipment'
- $ref: '#/components/schemas/DigitalLink'
- $ref: '#/components/schemas/Product'
description: ''
CmsPage:
type: object
title: CMS Page
description: 'The CMS Page model contains page data for Standard pages, Feature Pages and Homepages.'
x-internal: true
properties:
id:
type: string
example: '5'
type:
type: string
default: cms_page
attributes:
type: object
properties:
title:
type: string
example: About Us
content:
type: string
example: 'This is our about us page, it contains all information about our store.'
nullable: true
locale:
type: string
example: en
meta_description:
type: string
example: Learn about our store here on the about us page.
nullable: true
meta_title:
type: string
example: About Our Store - Shop Today
nullable: true
slug:
type: string
example: about-us
nullable: true
type:
type: string
example: 'Spree::Cms::Pages::StandardPage'
relationships:
type: object
properties:
cms_sections:
type: object
properties:
data:
type: array
nullable: true
items:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
CmsPageIncludes:
x-internal: true
title: CMS Page Includes
allOf:
- $ref: '#/components/schemas/CmsSection'
description: Hello!
CmsSection:
type: object
title: CMS Section
description: The CMS Section model represents a single section belonging to a CMS Page. CMS Sections can link to other resources through the `linked_resource`.
x-internal: true
properties:
id:
type: string
example: '1'
description: ''
type:
type: string
description: ''
default: cms_section
attributes:
type: object
properties:
name:
type: string
example: Main Hero
content:
type: object
nullable: true
settings:
type: object
nullable: true
link:
type: string
example: /t/categories/summer-collection
nullable: true
fit:
type: string
example: Screen
type:
type: string
example: 'Spree::Cms::Sections::HeroImage'
position:
type: integer
example: 1
image_one_sm:
type: string
example: /rails/active_storage/representations/redirect/eyJfc--jhusbxnd/main_hero.jpg
nullable: true
image_one_md:
type: string
example: /rails/active_storage/representations/redirect/eyJfc--eldkxjen/main_hero.jpg
nullable: true
image_one_lg:
type: string
example: /rails/active_storage/representations/redirect/eyJfc--uzggzusx/main_hero.jpg
nullable: true
image_one_xl:
type: string
example: /rails/active_storage/representations/redirect/eyJfc--lxpshbbc/main_hero.jpg
nullable: true
image_two_sm:
type: string
example: null
nullable: true
image_two_md:
type: string
example: null
nullable: true
image_two_lg:
type: string
example: null
nullable: true
image_two_xl:
type: string
example: null
nullable: true
image_three_sm:
type: string
example: null
nullable: true
image_three_md:
type: string
example: null
nullable: true
image_three_lg:
type: string
example: null
nullable: true
image_three_xl:
type: string
example: null
nullable: true
is_full_screen:
type: boolean
relationships:
type: object
properties:
linked_resource:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
Country:
title: Country
description: 'Countries within Spree are used as a container for states. Countries can be zone members, and also link to an address. The difference between one country and another on an address record can determine which tax rates and shipping methods are used for the order.[Read more about Countries in Spree](https://dev-docs.spreecommerce.org/internals/addresses#countries)'
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: country
attributes:
type: object
properties:
iso:
type: string
example: US
iso3:
type: string
example: USA
iso_name:
type: string
example: UNITED STATES
name:
type: string
example: United States
states_required:
type: boolean
zipcode_required:
type: boolean
default:
type: boolean
relationships:
type: object
properties:
states:
type: object
description: States associated with this Country
properties:
data:
type: array
items:
$ref: '#/components/schemas/State'
required:
- id
- type
- attributes
- relationships
CountryIncludes:
x-internal: true
title: Country Includes
oneOf:
- $ref: '#/components/schemas/State'
CreditCard:
title: Credit Card
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
example: credit_card
default: credit_card
attributes:
type: object
properties:
cc_type:
type: string
enum:
- visa
- mastercard
- amex
example: visa
last_digits:
type: string
example: '1111'
description: Last 4 digits of CC number
month:
type: number
description: Expiration date month
example: 12
year:
type: number
example: 2026
description: Expiration date year
name:
type: string
example: John Doe
description: Card holder name
default:
type: boolean
example: true
description: Defines if this is the default CC for a signed in user
relationships:
type: object
properties:
payment_method:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
CreditCardIncludes:
x-internal: true
title: Credit Card Includes
allOf:
- $ref: '#/components/schemas/PaymentMethod'
Error:
x-internal: true
title: Error
type: object
properties:
error:
type: string
Icon:
type: object
description: 'The Icon object contains a url attribute pointing to an Active Storage asset. '
title: Icon
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: icon
attributes:
type: object
properties:
url:
type: string
required:
- id
- type
- attributes
Image:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
default: image
attributes:
type: object
properties:
position:
type: integer
description: Sort order of images set in the Admin Panel
example: 0
minimum: 0
styles:
type: array
description: An array of pre-scaled image styles
items:
$ref: '#/components/schemas/ImageStyle'
required:
- id
- type
- attributes
title: Image
x-internal: true
ImageStyle:
x-internal: true
title: Image Style
type: object
properties:
url:
type: string
example: 'http://localhost:3000/rails/active_storage/disk/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaEpJbWQyWVhKcFlXNTBjeTltWm1sMmRURlNORFpZWjJaSFpYUkdZMjk2WWsxM1RHWXZNVGs1T1RCak5XVmlNamN4TlRnd1pqVTBabUpqTWpCbFkyVXhZMlZpTTJFd05ERTJZemMzT0dKaE5tSTFNREkyT0dKaFpqa3paV1JtWTJWaE16aGxaQVk2QmtWVSIsImV4cCI6IjIwMTgtMDYtMjRUMTM6NTk6NTguOTY5WiIsInB1ciI6ImJsb2Jfa2V5In19--5e9ff358dc747f73754e332678c5762114ac6f3f/ror_jr_spaghetti.jpeg?content_type=image%2Fjpeg&disposition=inline%3B+filename%3D%22ror_jr_spaghetti.jpeg%22%3B+filename%2A%3DUTF-8%27%27ror_jr_spaghetti.jpeg'
description: Absolute URL of the uploaded image in selected style (width/height)
width:
type: integer
example: 1920
description: Actual width of image
height:
type: integer
example: 1080
description: Actual height of image
ListLinks:
x-internal: true
type: object
title: Pagination Links
properties:
self:
type: string
description: URL to the current page of the listing
next:
type: string
description: URL to the next page of the listing
prev:
type: string
description: URL to the previous page of the listing
last:
type: string
description: URL to the last page of the listing
first:
type: string
description: URL to the first page of the listing
ListMeta:
type: object
x-internal: true
title: Pagination Meta
properties:
count:
type: number
example: 7
description: Number of items on the current listing
total_count:
type: number
example: 145
description: Number of all items matching the criteria
total_pages:
type: number
example: 10
description: Number of all pages containing items matching the criteria
LineItem:
title: Line Item
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: line_item
attributes:
type: object
properties:
name:
type: string
example: Sample product
quantity:
type: integer
example: 1
slug:
type: string
example: sample-product
options_text:
type: string
example: 'Size: small, Color: red'
price:
type: string
example: '125.0'
description: Price of Product per quantity
currency:
type: string
example: USD
display_price:
type: string
example: $125.00
description: Price of Product per quantity
total:
type: string
example: '250.0'
description: 'Total price of Line Item including adjastments, promotions and taxes'
display_total:
type: string
example: $250.00
description: 'Total price of Line Item including adjastments, promotions and taxes'
adjustment_total:
type: string
example: '10.0'
description: TBD
display_adjustment_total:
type: string
example: $10.00
description: TBD
additional_tax_total:
type: string
example: '5.0'
display_additional_tax_total:
type: string
example: $5.00
discounted_amount:
type: string
example: '125.0'
display_discounted_amount:
type: string
example: $125.00
pre_tax_amount:
type: string
example: '125.0'
display_pre_tax_amount:
type: string
example: $125.00
promo_total:
type: string
example: '-5.0'
display_promo_total:
type: string
included_tax_total:
type: string
example: '0.0'
description: 'Taxes included in the price, eg. VAT'
display_inluded_tax_total:
type: string
example: $0.00
public_metadata:
type: object
example:
recommended_by_us: true
description: The public metadata for the Line Item.
relationships:
type: object
properties:
variant:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
digital_links:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
description: ''
Menu:
type: object
title: Menu
x-internal: true
properties:
id:
type: string
example: '2'
type:
type: string
default: menu
attributes:
type: object
properties:
name:
type: string
example: Footer Menu (English)
location:
type: string
enum:
- footer
- header
locale:
type: string
example: en
relationships:
type: object
properties:
menu_items:
type: object
properties:
data:
type: array
items:
allOf:
- $ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
MenuItem:
title: Menu Item
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: menu_item
attributes:
type: object
properties:
name:
type: string
example: Mens Shorts
subtitle:
type: string
example: Buy Mens Shorts
nullable: true
destination:
type: string
example: /t/categories/mens/shorts
nullable: true
new_window:
type: boolean
item_type:
type: string
example: Link
code:
type: string
example: promo
nullable: true
lft:
type: integer
rgt:
type: integer
depth:
type: integer
link:
type: string
nullable: true
is_container:
type: boolean
is_root:
type: boolean
is_child:
type: boolean
is_leaf:
type: boolean
relationships:
type: object
properties:
parent:
type: object
description: Parent node
properties:
data:
$ref: '#/components/schemas/Relation'
children:
type: object
description: List of child nodes
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
menu:
type: object
description: Menu associated with this Menu Item
properties:
data:
$ref: '#/components/schemas/Relation'
icon:
type: object
description: Icon associated with Menu Item
properties:
data:
$ref: '#/components/schemas/Relation'
linked_resource:
type: object
description: Linked Resource associated with this Menu Item
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
MenuIncludes:
x-internal: true
title: Menu Includes
anyOf:
- $ref: '#/components/schemas/MenuItem'
- $ref: '#/components/schemas/Taxon'
- $ref: '#/components/schemas/Product'
- $ref: '#/components/schemas/CmsPage'
- $ref: '#/components/schemas/Icon'
OptionType:
title: Option Type
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: option_type
attributes:
type: object
properties:
name:
type: string
example: color
presentation:
type: string
example: Color
position:
type: integer
example: 1
required:
- id
- type
- attributes
Payment:
title: Payment
type: object
description: ''
x-internal: true
properties:
id:
type: string
type:
type: string
default: payment
attributes:
type: object
properties:
amount:
type: string
default: '200.57'
response_code:
type: integer
default: 192
number:
type: string
default: PV7B4YH0
cvv_response_code:
type: integer
default: 200
cvv_response_message:
type: string
default: authorized
payment_method_id:
type: integer
default: 1
payment_method_name:
type: string
default: Credit Card
state:
type: string
default: paid
relationships:
type: object
properties:
source:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
payment_method:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
PaymentMethod:
title: Payment Method
description: ''
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: payment_method
attributes:
type: object
properties:
type:
type: string
example: 'Spree::Gateway::StripeGateway'
name:
type: string
example: Stripe
description:
type: string
example: Stripe Payments
nullable: true
preferences:
type: object
required:
- id
- type
- attributes
Product:
type: object
title: Product
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: product
attributes:
type: object
properties:
name:
type: string
example: Example product
description:
type: string
example: Example description
nullable: true
available_on:
type: string
example: '2012-10-17T03:43:57Z'
nullable: true
slug:
type: string
example: example-product
price:
type: string
example: '15.99'
nullable: true
currency:
type: string
example: USD
display_price:
type: string
example: $15.99
nullable: true
purchasable:
type: boolean
description: Indicates if any of Variants are in stock or backorderable
in_stock:
type: boolean
description: Indicates if any of Variants are in stock
backorderable:
type: boolean
description: Indicates if any of Variants are backeorderable
meta_description:
type: string
example: Example product
nullable: true
meta_keywords:
type: string
example: 'example, product'
nullable: true
updated_at:
$ref: '#/components/schemas/Timestamp'
sku:
type: string
example: 9238-WS
available:
type: boolean
compare_at_price:
type: string
example: '49.99'
nullable: true
display_compare_at_price:
type: string
example: $49.99
nullable: true
relationships:
type: object
properties:
variants:
type: object
description: 'List of Product Variants, excluding Master Variant'
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
option_types:
type: object
description: List of Product Option Types
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
product_properties:
type: object
description: List of Product Properties
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
taxons:
type: object
description: List of Taxons associated with this Product
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
images:
type: object
description: List of Images associated with this Product
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
default_variant:
type: object
description: The default Variant for this product
properties:
data:
$ref: '#/components/schemas/Relation'
primary_variant:
type: object
description: The Primary Variant for this product
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
ProductIncludes:
x-internal: true
title: Product Includes
anyOf:
- $ref: '#/components/schemas/OptionType'
- $ref: '#/components/schemas/ProductProperty'
- $ref: '#/components/schemas/Variant'
- $ref: '#/components/schemas/Image'
- $ref: '#/components/schemas/Taxon'
StoreIncludes:
x-internal: true
title: Store Includes
anyOf:
- $ref: '#/components/schemas/Country'
- $ref: '#/components/schemas/Menu'
- $ref: '#/components/schemas/CmsPage'
ProductProperty:
title: Product Property
type: object
properties:
id:
type: string
example: '1'
type:
type: string
default: product_property
attributes:
type: object
properties:
value:
type: string
example: Wilson
filter_param:
type: string
example: wilson
name:
type: string
example: manufacturer
description:
type: string
example: Manufacturer
required:
- id
- type
- attributes
x-internal: true
Promotion:
type: object
title: Promotion
properties:
id:
type: string
example: '1'
type:
type: string
default: promotion
attributes:
type: object
properties:
name:
type: string
example: 10% Discount
description:
type: string
example: Super discount for you
amount:
type: string
example: '-10.0'
display_amount:
type: string
example: '-$10.00'
code:
type: string
example: BLK-FRI
required:
- id
- type
- attributes
x-internal: true
Relation:
type: object
nullable: true
properties:
id:
type: string
type:
type: string
required:
- id
- type
x-internal: true
description: ''
State:
type: object
description: 'States within Spree are used to scope address data slightly more than country. States are useful for tax purposes, as different states in a country may impose different tax rates on different products. In addition to this, different states may cause different tax rates and shipping methods to be used for an order, similar to how countries affect it also.'
title: State
properties:
abbr:
type: string
example: NY
description: State abbreviation
name:
type: string
example: New York
description: State name
x-internal: true
Store:
type: object
description: Stores are the center of the Spree ecosystem. Each Spree installation can have multiple Stores. Each Store operates on a different domain or subdomain.
title: Store
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: store
attributes:
type: object
properties:
name:
type: string
example: Spree Demo
description: Name of the Store
url:
type: string
example: spree-demo.com
description: Store Url
meta_description:
type: string
example: Luxury clothing store for men and women.
description: Meta description for SEO
meta_keywords:
type: string
example: luxury clothing men women
description: Meta keywords for SEO
seo_title:
type: string
example: Buy Luxury Clothing With Ease
description: The title for SEO
default_currency:
type: string
example: EUR
description: Default currency of the store
default:
type: boolean
example: true
description: Indicates if the Store is the default one
supported_currencies:
type: string
example: 'EUR,USD,GBP'
description: All currencies supported by store
facebook:
type: string
example: 'https://www.facebook.com/mystorename'
description: URL of Facebook page
twitter:
type: string
example: 'https://twitter.com/mystorename'
description: URL of Twitter page
instagram:
type: string
example: 'https://instagram.com/mystorename'
description: URL of Instagram page
default_locale:
type: string
example: en
description: Default locale of the Store
supported_locales:
type: string
example: 'en,es,de'
description: Supported locales of the Store
customer_support_email:
type: string
example: support@mystore.com
description: This email is visible to your Store visitors in the Footer section
description:
type: string
example: Mystore has been selling luxury clothing for more than 20 years and has 15 stores currently.
description: Description of the Store which is visible in the Footer
address:
type: string
example: '813 Howard Street, Oswego NY 13126, USA'
description: Address of the Store which is visible in the Footer
contact_phone:
type: string
example: '+123456789'
description: Contact phone number of the Store which is visible in the Footer
favicon_path:
type: string
example: /assets/favicon.ico
relationships:
type: object
properties:
menus:
type: object
description: Menus
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
cms_pages:
type: object
description: CMS Pages
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
default_country:
type: object
description: Default Country of the Store
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
Shipment:
type: object
title: Shipment
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: shipment
attributes:
type: object
properties:
number:
type: string
example: H121354
description: Unique Shipment identifier
free:
type: boolean
description: 'Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart'
final_price:
type: string
example: '10.0'
description: Price to be presented for the Customer
display_final_price:
type: string
example: $10.00
tracking_url:
type: string
example: 'https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels=4123412434%2C'
description: Tracking URL to the service provider website
nullable: true
state:
type: string
example: shipped
enum:
- pending
- ready
- shipped
- canceled
description: |-
Status of the Shipment. For a list of all available statuses please refer:
Shipment section in Spree Guides
shipped_at:
type: string
format: date-time
example: '2021-01-02 13:42:12'
description: Date when Shipment was being sent from the warehouse
nullable: true
relationships:
type: object
properties:
stock_location:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
shipping_rates:
type: object
properties:
data:
type: array
items:
allOf:
- $ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
ShipmentIncludes:
x-internal: true
title: Shipment Includes
allOf:
- $ref: '#/components/schemas/ShippingRate'
- $ref: '#/components/schemas/StockLocation'
ShippingRate:
type: object
title: Shipping Rate
description: ''
x-internal: true
properties:
id:
type: string
example: '1'
nullable: true
type:
type: string
default: shipping_rate
attributes:
type: object
properties:
name:
type: string
example: USPS Ground
selected:
type: boolean
example: true
cost:
type: string
example: '10.0'
description: Price of the service without discounts applied
tax_amount:
type: string
example: '0.0'
description: Eligible tax for service (if any)
shipping_method_id:
type: integer
example: 1
description: ID of a Shipping Method. You will need this for the Checkout Update action
final_price:
type: string
example: '10.0'
description: Price to be presented for the Customer
display_cost:
type: string
example: $10.00
display_final_price:
type: string
example: $10.00
display_tax_amount:
type: string
example: $0.00
free:
type: boolean
example: true
description: 'Indicates if the Shipping Rate is free, eg. when Free shipping promo applied to Cart'
required:
- id
- type
- attributes
StockLocation:
title: Stock Location
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: stock_location
attributes:
type: object
properties:
name:
type: string
example: Main Warehouse
required:
- id
- type
- attributes
Taxon:
title: Taxon
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: taxon
attributes:
type: object
properties:
name:
type: string
example: T-shirts
pretty_name:
type: string
example: Clothes > T-shirts
permalink:
type: string
example: t-shirts
seo_title:
type: string
example: Clothes - T-shirts
meta_title:
type: string
example: T-shirts
nullable: true
meta_description:
type: string
example: 'A list of cool t-shirts '
nullable: true
meta_keywords:
type: string
example: 't-shirts, cool'
nullable: true
left:
type: integer
example: 1
right:
type: integer
example: 2
position:
type: integer
example: 0
depth:
type: integer
example: 1
nullable: true
is_root:
type: boolean
example: true
description: Indicates if the Taxon is the root node of this Taxonomy tree
is_child:
type: boolean
example: true
description: Returns true is this is a child node of this Taxonomy tree
is_leaf:
type: boolean
example: false
description: Returns true if this is the end of a branch of this Taxonomy tree
updated_at:
type: string
example: '2018-06-18T10:57:29.704Z'
relationships:
type: object
properties:
parent:
type: object
description: Parent node
properties:
data:
$ref: '#/components/schemas/Relation'
children:
type: object
description: List of child nodes
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
taxonomy:
type: object
description: Taxonomy associated with this Taxon
properties:
data:
$ref: '#/components/schemas/Relation'
image:
type: object
description: Image associated with Taxon
properties:
data:
$ref: '#/components/schemas/Relation'
products:
type: object
description: List of active and available Products associated with this Taxon
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
TaxonImage:
type: object
properties:
id:
type: string
example: '1'
type:
type: string
default: taxon_image
attributes:
type: object
properties:
position:
type: integer
example: 0
description: Sort order of images set in the Admin Panel
styles:
type: array
description: An array of pre-scaled image styles
items:
$ref: '#/components/schemas/ImageStyle'
required:
- id
- type
- attributes
title: Taxon Image
x-internal: true
TaxonIncludes:
x-internal: true
title: Taxon Includes
anyOf:
- $ref: '#/components/schemas/Product'
- $ref: '#/components/schemas/TaxonImage'
- $ref: '#/components/schemas/Taxonomy'
Taxonomy:
type: object
title: Taxonomy
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: taxonomy
attributes:
type: object
properties:
name:
type: string
example: Categories
position:
type: integer
example: 0
required:
- id
- type
- attributes
Timestamp:
type: string
format: date-time
example: '2020-02-16T07:14:54.617Z'
x-internal: true
title: Time Stamp
x-examples:
example-1: '2020-02-16T07:14:54.617Z'
User:
type: object
title: User
description: ' '
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: user
attributes:
type: object
properties:
email:
type: string
example: spree@example.com
first_name:
type: string
example: John
last_name:
type: string
example: Doe
store_credits:
type: number
example: 150.75
completed_orders:
type: number
example: 3
description: Number of placed Orders by this User
public_metadata:
type: object
example:
user_segment: supplier
description: The public metadata for this User
relationships:
type: object
properties:
default_billing_address:
type: object
description: Default billing address associated with this Account
properties:
data:
$ref: '#/components/schemas/Relation'
default_shipping_address:
type: object
description: Default shipping address associated with this Account
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
Variant:
title: Variant
description: 'Variant records track the individual variants of a Product. Variants are of two types: master variants and normal variants.'
x-examples: {}
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: variant
attributes:
type: object
properties:
sku:
type: string
example: SKU-1001
price:
type: string
example: '15.99'
currency:
type: string
example: USD
display_price:
type: string
example: $15.99
weight:
type: string
example: '10'
nullable: true
height:
type: string
example: '10'
nullable: true
width:
type: string
example: '10'
nullable: true
depth:
type: string
example: '10'
nullable: true
is_master:
type: boolean
description: Indicates if Variant is the master Variant
options_text:
type: string
example: 'Size: small, Color: red'
purchasable:
type: boolean
description: Indicates if Variant is in stock or backorderable
in_stock:
type: boolean
description: Indicates if Variant is in stock
backorderable:
type: boolean
relationships:
type: object
properties:
product:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
images:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
option_values:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
WishedItem:
type: object
x-internal: true
properties:
id:
type: string
type:
type: string
default: wished_item
attributes:
type: object
properties:
quantity:
type: integer
price:
type: string
total:
type: string
display_price:
type: string
display_total:
type: string
relationships:
type: object
properties:
variant:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
WishedItemIncludes:
x-internal: true
title: Wished Item Includes
allOf:
- $ref: '#/components/schemas/Variant'
Wishlist:
description: ''
type: object
title: Wishlist
x-internal: true
properties:
id:
type: string
type:
type: string
default: wishlist
attributes:
type: object
properties:
token:
type: string
name:
type: string
is_private:
type: boolean
is_default:
type: boolean
variant_included:
type: boolean
description: Returns `true` or `false` depending on the variant ID passed in through the `is_variant_included` query param.
relationships:
type: object
properties:
wished_items:
type: object
properties:
data:
type: array
items:
allOf:
- $ref: '#/components/schemas/Relation'
required:
- id
- type
- attributes
- relationships
WishlistIncludes:
x-internal: true
title: Wishlist Includes
allOf:
- $ref: '#/components/schemas/WishedItem'
DigitalLink:
title: Digital Link
type: object
x-internal: true
properties:
id:
type: string
example: '1'
type:
type: string
default: digital_link
attributes:
type: object
properties:
token:
type: string
example: Gn6srBmmR4KrWy73LRtrBKYw
relationships:
type: object
properties:
line_item:
type: object
properties:
data:
$ref: '#/components/schemas/Relation'
description: Digital links are accessible in the order includes line_items.digital_links
parameters:
Token:
name: token
in: path
required: true
description: The token is a unique string used to identify the target resource.
schema:
type: string
example: vmJtMiMozBdFtn1VkdJ8dYen
ItemId:
name: item_id
in: path
required: true
description: The wished item id
schema:
type: string
example: '3'
CmsPageSlug:
name: cms_page_slug
in: path
required: true
description: CMS Page Slug
schema:
type: string
example: about-us
CmsPageIncludeParam:
name: include
in: query
description: 'Pass `cms_sections` as an include value to fetch the CMS Sections associated with each CMS Page. If you need to fetch the CMS Sections Linked Resource, you can pass `cms_sections.linked_resource`.'
schema:
type: string
example: cms_sections.linked_resource
CreditCardIncludeParam:
name: include
in: query
required: false
schema:
type: string
example: payment_method
description: 'Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes).'
MenuIncludeParam:
name: include
in: query
description: 'Pass `menu_items` as an include value to fetch the Menu Items associated with each Menu. If you need to fetch the Menu Item Linked Resource, you can pass `menu_items.linked_resource`, additionally, you can pass `menu_items.icon` to fetch the associated Icon for each menu Item'
schema:
type: string
example: menu_items.linked_resource
LocaleParam:
name: locale
in: query
description: Pass `locale` as value to fetch the resources with the matching locale for example `?locale=fr`.
schema:
type: string
example: en
ProductSlug:
name: product_slug
in: path
required: true
description: Product Slug
schema:
type: string
example: knitted-high-neck-sweater
TaxonPermalink:
name: taxon_permalink
in: path
required: true
description: Specify the taxon using the permalink or taxon ID.
schema:
type: string
example: categories/women
PageParam:
name: page
in: query
description: Number of requested page when paginating collection
schema:
type: integer
example: 1
PerPageParam:
name: per_page
in: query
description: Number of requested records per page when paginating collection
schema:
type: integer
example: 25
OrderParam:
name: order_number
in: path
required: true
description: 'The required **{order_number}** value can be found in the cart response body, identified as the `number` attribute.'
schema:
type: string
example: R653163382
example: R653163382
CartIncludeParam:
name: include
in: query
schema:
type: string
description: 'Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes).'
example: 'line_items,variants,variants.images,billing_address,shipping_address,user,payments,shipments,promotions'
CartCurrencyParam:
name: currency
in: query
schema:
type: string
description: 'Must be specified when is different than current store default currency.'
example: 'USD'
ProductIncludeParam:
name: include
in: query
schema:
type: string
description: |-
Specify what related resources (relationships) you would like to receive in the response body. Eg.
```
default_variant,variants,option_types,product_properties,taxons,images,primary_variant
```
[More information](https://jsonapi.org/format/#fetching-includes)
example: 'default_variant,variants,option_types,product_properties,taxons,images,primary_variant'
StoreIncludeParam:
name: include
in: query
schema:
type: string
description: |-
Specify what related resources (relationships) you would like to receive in the response body. Eg.
```
default_country,menus,cms_pages
```
[More information](https://jsonapi.org/format/#fetching-includes)
example: 'default_country,menus,cms_pages'
ProductImageTransformationSizeParam:
in: query
name: 'image_transformation[size]'
schema:
type: string
example: 100x50
description: Specifies dimensions for included images at transformed_url attribute.
ProductImageTransformationQualityParam:
in: query
name: 'image_transformation[quality]'
schema:
type: string
example: '70'
description: Specifies quality for included images at transformed_url attribute
TaxonIncludeParam:
name: include
in: query
schema:
type: string
description: 'Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes).'
example: 'parent,taxonomy,children,image,products'
IsoOrIso3:
name: iso
in: path
required: true
description: Provide a Country ISO `US` or ISO3 `USA` code.
schema:
type: string
example: GB
CountryIncludeParam:
name: include
in: query
schema:
type: string
description: 'Specify the related resources you would like to receive in the response body. [More Information](https://jsonapi.org/format/#fetching-includes).'
example: states
AccountIncludeParam:
name: include
in: query
schema:
type: string
description: Pass `default_billing_address` and/or `default_shipping_address` as value to include selected addresses information
example: 'default_billing_address,default_shipping_address'
WishlistIncludeParam:
name: include
in: query
schema:
type: string
example: wished_items.variant
description: 'Specify the related resources you would like to receive in the `included` section of the response body. You can also retrieve related resources of included resources by using the dot notation, eg. `wished_items.variant`. [More information](https://jsonapi.org/format/#fetching-includes).'
WishlistIsVariantIncludedParam:
name: is_variant_included
in: query
schema:
type: string
example: '150'
description: 'Check for the presence of a variant in a wishlist by passing the variant ID, if the variant is present in the wishlist, the `variant_included` attribute will return `true`'
FilterByIds:
in: query
name: 'filter[ids]'
schema:
type: string
example: '1,2,3'
description: Fetch only resources with corresponding IDs
FilterBySKUs:
in: query
name: 'filter[skus]'
schema:
type: string
example: 'SKU-123,SKU-345'
description: Fetch only resources with corresponding SKUs
FilterByName:
in: query
name: 'filter[name]'
schema:
type: string
example: rails
description: 'Find resources with matching name (supports wild-card, partial-word match search)'
FilterByTitle:
name: 'filter[title]'
in: query
description: Fetch only resources with correspondingTitle
schema:
type: string
example: About Us
FilterByType:
name: 'filter[type]'
in: query
description: Fetch only resources with corresponding Type
schema:
type: string
example: home
FilterByLocation:
name: 'filter[location]'
in: query
description: Fetch only resources with corresponding Location
schema:
type: string
example: header
SparseFieldsAddress:
in: query
name: 'fields[address]'
example: 'firstname,lastname,country_name'
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
SparseFieldsUser:
name: 'fields[user]'
in: query
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
example: 'email,completed_orders'
SparseFieldsCart:
name: 'fields[cart]'
in: query
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
example: 'token,currency,number'
SparseFieldsCountry:
name: 'fields[country]'
in: query
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
example: 'iso_name,name,states_required'
SparseFieldsCreditCard:
name: 'fields[credit_card]'
in: query
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
example: 'cc_type,last_digits,month,year,name,default'
SparseFieldsProduct:
name: 'fields[product]'
in: query
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
example: 'price,description,name'
SparseFieldsStore:
name: 'fields[store]'
in: query
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
example: 'name,url,supported_locales'
SparseFieldsShippingRate:
in: query
name: 'fields[shipping_rate]'
example: 'name,selected,final_price,display_final_price,cost,display_cost,tax_amount,display_tax_amount,shipping_method_id'
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
SparseFieldsTaxon:
in: query
name: 'fields[taxon]'
example: 'name,pretty_name,permalink'
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
SparseFieldsWishlist:
in: query
name: 'fields[wishlist]'
example: 'name,token,is_default,is_private,variant_included'
description: 'Specify the fields you would like returned in the response body. [More information](https://jsonapi.org/format/#fetching-sparse-fieldsets).'
schema:
type: string
responses:
404NotFound:
description: 404 Not Found - Resource not found.
content:
application/vnd.api+json:
schema:
properties:
error:
type: string
example: The resource you were looking for could not be found.
default: The resource you were looking for could not be found.
examples:
404 Example:
value:
error: The resource you were looking for could not be found.
403Forbidden:
description: 403 Forbidden - You are not authorized to access this page.
content:
application/vnd.api+json:
schema:
properties:
error:
type: string
example: You are not authorized to access this page.
default: You are not authorized to access this page.
examples:
403 Example:
value:
error: You are not authorized to access this page.
422UnprocessableEntity:
description: 422 Unprocessable Entity
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Error'
examples:
422 Example:
value:
error: Example is invalid
errors:
example:
- Example is invalid
Cart:
description: 200 Success - Returns the `cart` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Cart'
included:
type: array
items:
$ref: '#/components/schemas/CartIncludes'
required:
- data
examples:
Empty Cart:
value:
data:
id: '17'
type: cart
attributes:
number: R233871560
item_total: '0.0'
total: '0.0'
ship_total: '0.0'
adjustment_total: '0.0'
created_at: '2021-09-28T22:15:07.471Z'
updated_at: '2021-09-28T22:15:07.471Z'
completed_at: null
included_tax_total: '0.0'
additional_tax_total: '0.0'
display_additional_tax_total: $0.00
display_included_tax_total: $0.00
tax_total: '0.0'
currency: USD
state: cart
token: zTEpsukRq_yEUcXVCSv0uw1632867307450
email: null
display_item_total: $0.00
display_ship_total: $0.00
display_adjustment_total: $0.00
display_tax_total: $0.00
promo_total: '0.0'
display_promo_total: $0.00
item_count: 0
special_instructions: null
display_total: $0.00
pre_tax_item_amount: '0.0'
display_pre_tax_item_amount: $0.00
pre_tax_total: '0.0'
display_pre_tax_total: $0.00
shipment_state: null
payment_state: null
relationships:
line_items:
data: []
variants:
data: []
promotions:
data: []
payments:
data: []
shipments:
data: []
user:
data: null
billing_address:
data: null
shipping_address:
data: null
Populated Cart:
value:
data:
id: '11'
type: cart
attributes:
number: R823511564
item_total: '287.97'
total: '316.0'
ship_total: '5.0'
adjustment_total: '23.03'
created_at: '2021-09-28T12:57:15.148Z'
updated_at: '2021-09-28T13:06:02.689Z'
completed_at: null
included_tax_total: '26.18'
additional_tax_total: '51.83'
display_additional_tax_total: $51.83
display_included_tax_total: $26.18
tax_total: '78.01'
currency: USD
state: payment
token: VDK_6q_NNdWFc81VZRpUfQ1632833835148
email: spree@example.com
display_item_total: $287.97
display_ship_total: $5.00
display_adjustment_total: $23.03
display_tax_total: $78.01
promo_total: '-28.8'
display_promo_total: '-$28.80'
item_count: 3
special_instructions: null
display_total: $316.00
pre_tax_item_amount: '261.7909'
display_pre_tax_item_amount: $261.79
pre_tax_total: '266.7909'
display_pre_tax_total: $266.79
shipment_state: null
payment_state: null
relationships:
line_items:
data:
- id: '6'
type: line_item
variants:
data:
- id: '130'
type: variant
promotions:
data:
- id: '2'
type: promotion
payments:
data: []
shipments:
data:
- id: '7'
type: shipment
user:
data:
id: '1'
type: user
billing_address:
data:
id: '25'
type: address
shipping_address:
data:
id: '25'
type: address
Completed Cart:
value:
data:
id: '18'
type: cart
attributes:
number: R177608027
item_total: '474.95'
total: '527.45'
ship_total: '5.0'
adjustment_total: '47.5'
created_at: '2021-09-28T22:31:47.401Z'
updated_at: '2021-09-28T22:33:20.257Z'
completed_at: '2021-09-28T22:33:18.372Z'
included_tax_total: '0.0'
additional_tax_total: '47.5'
display_additional_tax_total: $47.50
display_included_tax_total: $0.00
tax_total: '47.5'
currency: USD
state: complete
token: 5DUe7Jg40Lu-SoEvAKRKcQ1632868307387
email: spree@example.com
display_item_total: $474.95
display_ship_total: $5.00
display_adjustment_total: $47.50
display_tax_total: $47.50
promo_total: '0.0'
display_promo_total: $0.00
item_count: 5
special_instructions: null
display_total: $527.45
pre_tax_item_amount: '474.95'
display_pre_tax_item_amount: $474.95
pre_tax_total: '479.95'
display_pre_tax_total: $479.95
shipment_state: ready
payment_state: paid
relationships:
line_items:
data:
- id: '1'
type: line_item
variants:
data:
- id: '131'
type: variant
promotions:
data:
- id: '2'
type: promotion
payments:
data:
- id: '1'
type: payment
shipments:
data:
- id: '1'
type: shipment
user:
data:
id: '1'
type: user
billing_address:
data:
id: '5'
type: address
shipping_address:
data:
id: '5'
type: address
Completed Cart with all included objects:
value:
data:
id: '18'
type: cart
attributes:
number: R177608027
item_total: '474.95'
total: '527.45'
ship_total: '5.0'
adjustment_total: '47.5'
created_at: '2021-09-28T22:31:47.401Z'
updated_at: '2021-09-28T22:57:22.132Z'
completed_at: '2021-09-28T22:33:18.372Z'
included_tax_total: '0.0'
additional_tax_total: '47.5'
display_additional_tax_total: $47.50
display_included_tax_total: $0.00
tax_total: '47.5'
currency: USD
state: complete
token: 5DUe7Jg40Lu-SoEvAKRKcQ1632868307387
email: spree@example.com
display_item_total: $474.95
display_ship_total: $5.00
display_adjustment_total: $47.50
display_tax_total: $47.50
promo_total: '0.0'
display_promo_total: $0.00
item_count: 5
special_instructions: null
display_total: $527.45
pre_tax_item_amount: '474.95'
display_pre_tax_item_amount: $474.95
pre_tax_total: '479.95'
display_pre_tax_total: $479.95
shipment_state: shipped
payment_state: paid
relationships:
line_items:
data:
- id: '1'
type: line_item
variants:
data:
- id: '131'
type: variant
promotions:
data:
- id: '2'
type: promotion
payments:
data:
- id: '1'
type: payment
shipments:
data:
- id: '1'
type: shipment
user:
data:
id: '1'
type: user
billing_address:
data:
id: '5'
type: address
shipping_address:
data:
id: '5'
type: address
included:
- id: '1'
type: line_item
attributes:
name: 3 4 Sleeve T Shirt
quantity: 5
price: '94.99'
slug: 3-4-sleeve-t-shirt
options_text: 'Color: white, Size: XS'
currency: USD
display_price: $94.99
total: '522.45'
display_total: $522.45
adjustment_total: '47.5'
display_adjustment_total: $47.50
additional_tax_total: '47.5'
discounted_amount: '474.95'
display_discounted_amount: $474.95
display_additional_tax_total: $47.50
promo_total: '0.0'
display_promo_total: $0.00
included_tax_total: '0.0'
display_included_tax_total: $0.00
pre_tax_amount: '474.95'
display_pre_tax_amount: $474.95
relationships:
variant:
data:
id: '131'
type: variant
- id: '2'
type: image
attributes:
transformed_url: null
styles:
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnczBPSGcwT0Q0R093WlVPZ3RsZUhSbGJuUkFDRG9QWW1GamEyZHliM1Z1WkVraUNYTm9iM2NHT3daVU9neHhkV0ZzYVhSNWFWVT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--d0a7a0441914cd12bba3deaa22e75ad707bbe414/Screenshot%202021-09-22%20at%2011.49.05.png
size: 48x48>
width: '48'
height: '48'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHhNREI0TVRBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--d762ce7883e0795601c092269daa49688aa534a2/Screenshot%202021-09-22%20at%2011.49.05.png
size: 100x100>
width: '100'
height: '100'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOREI0TWpRd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--a2fea1e7c9a6d545cfb8bbe33a5c79fc7f8ec39f/Screenshot%202021-09-22%20at%2011.49.05.png
size: 240x240>
width: '240'
height: '240'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHhOakI0TWpBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--325e7fb25376c8fd2db0ca1da35518354db00b11/Screenshot%202021-09-22%20at%2011.49.05.png
size: 160x200>
width: '160'
height: '200'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMDBORGg0TmpBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--3a7df15bde83cebd64c00bfea26fd006c7f25ab2/Screenshot%202021-09-22%20at%2011.49.05.png
size: 448x600>
width: '448'
height: '600'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOVFI0TXpRd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--438f3bed4c80d9865e1344c03f456aaccd2a9f57/Screenshot%202021-09-22%20at%2011.49.05.png
size: 254x340>
width: '254'
height: '340'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHpOVEI0TkRZNFBnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--941f9ccf86ad66e34328dc82c0bef4655208ee17/Screenshot%202021-09-22%20at%2011.49.05.png
size: 350x468>
width: '350'
height: '468'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlNako0TWprM1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--87e51af0bc0da167f5be35ba227a2c207dcac76a/Screenshot%202021-09-22%20at%2011.49.05.png
size: 222x297>
width: '222'
height: '297'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOemg0TXpjeFBnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--af798399e91d3d2d727103129483c0c59acdaa64/Screenshot%202021-09-22%20at%2011.49.05.png
size: 278x371>
width: '278'
height: '371'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMDJNREI0TmpBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--8bb21c9fc5f9a942fa9374de8860186465d99f8e/Screenshot%202021-09-22%20at%2011.49.05.png
size: 600x600>
width: '600'
height: '600'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOemg0TXpjeFBnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--af798399e91d3d2d727103129483c0c59acdaa64/Screenshot%202021-09-22%20at%2011.49.05.png
size: 278x371>
width: '278'
height: '371'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMDJOVEI0T0Rjd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--5546099d5e7c15cd4ea705d244dddd64f0e47fbc/Screenshot%202021-09-22%20at%2011.49.05.png
size: 650x870>
width: '650'
height: '870'
position: 1
alt: ''
original_url: /rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/Screenshot%202021-09-22%20at%2011.49.05.png
- id: '131'
type: variant
attributes:
sku: T-shirts_3_4sleevet-shirt_94.99_white_xs
weight: '0.0'
height: null
width: null
depth: null
is_master: false
options_text: 'Color: white, Size: XS'
purchasable: true
in_stock: true
backorderable: false
currency: USD
price: '94.99'
display_price: $94.99
compare_at_price: null
display_compare_at_price: null
relationships:
product:
data:
id: '15'
type: product
images:
data:
- id: '2'
type: image
option_values:
data:
- id: '1'
type: option_value
- id: '23'
type: option_value
- id: '5'
type: address
attributes:
firstname: ' Tyler'
lastname: Durden
address1: 3029 Street Way Drive
address2: Basement Entrance
city: LA
zipcode: '90210'
phone: '09128386372'
state_name: California
company: Paper Street Soap Co.
country_name: United States
country_iso3: USA
country_iso: US
label: null
state_code: CA
- id: '1'
type: user
attributes:
email: spree@example.com
store_credits: 0
completed_orders: 1
relationships:
default_billing_address:
data: null
default_shipping_address:
data: null
- id: '2'
type: promotion
attributes:
name: Black Friday
description: ''
amount: '-9.6'
display_amount: '-$9.60'
code: BLKFRI
- id: '1'
type: payment
attributes:
amount: '527.45'
response_code: null
number: PN43O2GK
cvv_response_code: null
cvv_response_message: null
payment_method_id: 2
payment_method_name: Check
state: completed
relationships:
source:
data: null
payment_method:
data:
id: '2'
type: payment_method
- id: '1'
type: shipment
attributes:
number: H77361385341
final_price: '5.0'
display_final_price: $5.00
state: shipped
shipped_at: '2021-09-28T22:57:22.108Z'
tracking_url: null
free: false
relationships:
shipping_rates:
data:
- id: '10'
type: shipping_rate
- id: '11'
type: shipping_rate
- id: '12'
type: shipping_rate
stock_location:
data:
id: '1'
type: stock_location
CartList:
description: 200 Success - Returns an array of `cart` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Cart'
included:
type: array
items:
$ref: '#/components/schemas/CartIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
Standard response:
value:
data:
- id: '18'
type: cart
attributes:
number: R177608027
item_total: '474.95'
total: '527.45'
ship_total: '5.0'
adjustment_total: '47.5'
created_at: '2021-09-28T22:31:47.401Z'
updated_at: '2021-09-28T22:33:20.257Z'
completed_at: '2021-09-28T22:33:18.372Z'
included_tax_total: '0.0'
additional_tax_total: '47.5'
display_additional_tax_total: $47.50
display_included_tax_total: $0.00
tax_total: '47.5'
currency: USD
state: complete
token: 5DUe7Jg40Lu-SoEvAKRKcQ1632868307387
email: spree@example.com
display_item_total: $474.95
display_ship_total: $5.00
display_adjustment_total: $47.50
display_tax_total: $47.50
promo_total: '0.0'
display_promo_total: $0.00
item_count: 5
special_instructions: null
display_total: $527.45
pre_tax_item_amount: '474.95'
display_pre_tax_item_amount: $474.95
pre_tax_total: '479.95'
display_pre_tax_total: $479.95
shipment_state: ready
payment_state: paid
relationships:
line_items:
data:
- id: '1'
type: line_item
variants:
data:
- id: '131'
type: variant
promotions:
data:
- id: '2'
type: promotion
payments:
data:
- id: '1'
type: payment
shipments:
data:
- id: '1'
type: shipment
user:
data:
id: '1'
type: user
billing_address:
data:
id: '5'
type: address
shipping_address:
data:
id: '5'
type: address
meta:
count: 1
total_count: 1
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/account/orders'
next: 'http://localhost:3000/api/v2/storefront/account/orders?page=1'
prev: 'http://localhost:3000/api/v2/storefront/account/orders?page=1'
last: 'http://localhost:3000/api/v2/storefront/account/orders?page=1'
first: 'http://localhost:3000/api/v2/storefront/account/orders?page=1'
Including all related objects:
value:
data:
- id: '18'
type: cart
attributes:
number: R177608027
item_total: '474.95'
total: '527.45'
ship_total: '5.0'
adjustment_total: '47.5'
created_at: '2021-09-28T22:31:47.401Z'
updated_at: '2021-09-28T22:33:20.257Z'
completed_at: '2021-09-28T22:33:18.372Z'
included_tax_total: '0.0'
additional_tax_total: '47.5'
display_additional_tax_total: $47.50
display_included_tax_total: $0.00
tax_total: '47.5'
currency: USD
state: complete
token: 5DUe7Jg40Lu-SoEvAKRKcQ1632868307387
email: spree@example.com
display_item_total: $474.95
display_ship_total: $5.00
display_adjustment_total: $47.50
display_tax_total: $47.50
promo_total: '0.0'
display_promo_total: $0.00
item_count: 5
special_instructions: null
display_total: $527.45
pre_tax_item_amount: '474.95'
display_pre_tax_item_amount: $474.95
pre_tax_total: '479.95'
display_pre_tax_total: $479.95
shipment_state: ready
payment_state: paid
relationships:
line_items:
data:
- id: '1'
type: line_item
variants:
data:
- id: '131'
type: variant
promotions:
data: []
payments:
data:
- id: '1'
type: payment
shipments:
data:
- id: '1'
type: shipment
user:
data:
id: '1'
type: user
billing_address:
data:
id: '5'
type: address
shipping_address:
data:
id: '5'
type: address
included:
- id: '1'
type: line_item
attributes:
name: 3 4 Sleeve T Shirt
quantity: 5
price: '94.99'
slug: 3-4-sleeve-t-shirt
options_text: 'Color: white, Size: XS'
currency: USD
display_price: $94.99
total: '522.45'
display_total: $522.45
adjustment_total: '47.5'
display_adjustment_total: $47.50
additional_tax_total: '47.5'
discounted_amount: '474.95'
display_discounted_amount: $474.95
display_additional_tax_total: $47.50
promo_total: '0.0'
display_promo_total: $0.00
included_tax_total: '0.0'
display_included_tax_total: $0.00
pre_tax_amount: '474.95'
display_pre_tax_amount: $474.95
relationships:
variant:
data:
id: '131'
type: variant
- id: '2'
type: image
attributes:
transformed_url: null
styles:
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnczBPSGcwT0Q0R093WlVPZ3RsZUhSbGJuUkFDRG9QWW1GamEyZHliM1Z1WkVraUNYTm9iM2NHT3daVU9neHhkV0ZzYVhSNWFWVT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--d0a7a0441914cd12bba3deaa22e75ad707bbe414/Screenshot%202021-09-22%20at%2011.49.05.png
size: 48x48>
width: '48'
height: '48'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHhNREI0TVRBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--d762ce7883e0795601c092269daa49688aa534a2/Screenshot%202021-09-22%20at%2011.49.05.png
size: 100x100>
width: '100'
height: '100'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOREI0TWpRd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--a2fea1e7c9a6d545cfb8bbe33a5c79fc7f8ec39f/Screenshot%202021-09-22%20at%2011.49.05.png
size: 240x240>
width: '240'
height: '240'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHhOakI0TWpBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--325e7fb25376c8fd2db0ca1da35518354db00b11/Screenshot%202021-09-22%20at%2011.49.05.png
size: 160x200>
width: '160'
height: '200'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMDBORGg0TmpBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--3a7df15bde83cebd64c00bfea26fd006c7f25ab2/Screenshot%202021-09-22%20at%2011.49.05.png
size: 448x600>
width: '448'
height: '600'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOVFI0TXpRd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--438f3bed4c80d9865e1344c03f456aaccd2a9f57/Screenshot%202021-09-22%20at%2011.49.05.png
size: 254x340>
width: '254'
height: '340'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHpOVEI0TkRZNFBnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--941f9ccf86ad66e34328dc82c0bef4655208ee17/Screenshot%202021-09-22%20at%2011.49.05.png
size: 350x468>
width: '350'
height: '468'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlNako0TWprM1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--87e51af0bc0da167f5be35ba227a2c207dcac76a/Screenshot%202021-09-22%20at%2011.49.05.png
size: 222x297>
width: '222'
height: '297'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOemg0TXpjeFBnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--af798399e91d3d2d727103129483c0c59acdaa64/Screenshot%202021-09-22%20at%2011.49.05.png
size: 278x371>
width: '278'
height: '371'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMDJNREI0TmpBd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--8bb21c9fc5f9a942fa9374de8860186465d99f8e/Screenshot%202021-09-22%20at%2011.49.05.png
size: 600x600>
width: '600'
height: '600'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMHlOemg0TXpjeFBnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--af798399e91d3d2d727103129483c0c59acdaa64/Screenshot%202021-09-22%20at%2011.49.05.png
size: 278x371>
width: '278'
height: '371'
- url: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDem9MWm05eWJXRjBTU0lJY0c1bkJqb0dSVlE2REdkeVlYWnBkSGxKSWd0alpXNTBaWElHT3daVU9ndHlaWE5wZW1WSklnMDJOVEI0T0Rjd1BnWTdCbFE2QzJWNGRHVnVkRUFJT2c5aVlXTnJaM0p2ZFc1a1NTSUpjMmh2ZHdZN0JsUTZESEYxWVd4cGRIbHBWUT09IiwiZXhwIjpudWxsLCJwdXIiOiJ2YXJpYXRpb24ifX0=--5546099d5e7c15cd4ea705d244dddd64f0e47fbc/Screenshot%202021-09-22%20at%2011.49.05.png
size: 650x870>
width: '650'
height: '870'
position: 1
alt: ''
original_url: /rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--ac481084a722edc7b7da2d96a29c3c4f4081c234/Screenshot%202021-09-22%20at%2011.49.05.png
- id: '131'
type: variant
attributes:
sku: T-shirts_3_4sleevet-shirt_94.99_white_xs
weight: '0.0'
height: null
width: null
depth: null
is_master: false
options_text: 'Color: white, Size: XS'
purchasable: true
in_stock: true
backorderable: false
currency: USD
price: '94.99'
display_price: $94.99
compare_at_price: null
display_compare_at_price: null
relationships:
product:
data:
id: '15'
type: product
images:
data:
- id: '2'
type: image
option_values:
data:
- id: '1'
type: option_value
- id: '23'
type: option_value
- id: '5'
type: address
attributes:
firstname: ' Tyler'
lastname: Durden
address1: 3029 Street Way Drive
address2: Basement Entrance
city: LA
zipcode: '90210'
phone: '09128386372'
state_name: California
company: Paper Street Soap Co.
country_name: United States
country_iso3: USA
country_iso: US
label: null
state_code: CA
- id: '1'
type: user
attributes:
email: spree@example.com
store_credits: 0
completed_orders: 1
relationships:
default_billing_address:
data: null
default_shipping_address:
data: null
- id: '2'
type: promotion
attributes:
name: Black Friday
description: ''
amount: '-9.6'
display_amount: '-$9.60'
code: BLKFRI
- id: '1'
type: payment
attributes:
amount: '527.45'
response_code: null
number: PN43O2GK
cvv_response_code: null
cvv_response_message: null
payment_method_id: 2
payment_method_name: Check
state: completed
relationships:
source:
data: null
payment_method:
data:
id: '2'
type: payment_method
- id: '1'
type: shipment
attributes:
number: H77361385341
final_price: '5.0'
display_final_price: $5.00
state: ready
shipped_at: null
tracking_url: null
free: false
relationships:
shipping_rates:
data:
- id: '10'
type: shipping_rate
- id: '11'
type: shipping_rate
- id: '12'
type: shipping_rate
stock_location:
data:
id: '1'
type: stock_location
meta:
count: 1
total_count: 1
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/account/orders?include=line_items,variants,variants.images,billing_address,shipping_address,user,payments,shipments,promotions'
next: 'http://localhost:3000/api/v2/storefront/account/orders?include=line_items%2Cvariants%2Cvariants.images%2Cbilling_address%2Cshipping_address%2Cuser%2Cpayments%2Cshipments%2Cpromotions&page=1'
prev: 'http://localhost:3000/api/v2/storefront/account/orders?include=line_items%2Cvariants%2Cvariants.images%2Cbilling_address%2Cshipping_address%2Cuser%2Cpayments%2Cshipments%2Cpromotions&page=1'
last: 'http://localhost:3000/api/v2/storefront/account/orders?include=line_items%2Cvariants%2Cvariants.images%2Cbilling_address%2Cshipping_address%2Cuser%2Cpayments%2Cshipments%2Cpromotions&page=1'
first: 'http://localhost:3000/api/v2/storefront/account/orders?include=line_items%2Cvariants%2Cvariants.images%2Cbilling_address%2Cshipping_address%2Cuser%2Cpayments%2Cshipments%2Cpromotions&page=1'
User:
description: 200 Success - Returns the `user` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/User'
included:
type: array
items:
allOf:
- $ref: '#/components/schemas/Address'
required:
- data
examples:
Standard response:
value:
data:
id: '1'
type: user
attributes:
email: spree@example.com
first_name: John
last_name: Snow
store_credits: 0
completed_orders: 0
public_metadata:
user_segment: supplier
relationships:
default_billing_address:
data:
id: '2'
type: address
default_shipping_address:
data:
id: '1'
type: address
Including Addresses:
value:
data:
id: '1'
type: user
attributes:
email: spree@example.com
store_credits: 0
completed_orders: 0
relationships:
default_billing_address:
data:
id: '2'
type: address
default_shipping_address:
data:
id: '1'
type: address
included:
- id: '2'
type: address
attributes:
firstname: Destiny
lastname: Maggio
address1: 12775 Runolfsdottir Greens
address2: Apt. 704
city: Kochmouth
zipcode: '16804'
phone: 1-257-860-8433
state_name: New York
company: null
country_name: United States
country_iso3: USA
country_iso: US
state_code: NY
- id: '1'
type: address
attributes:
firstname: Aimee
lastname: Jast
address1: 56593 Baumbach Meadows
address2: Suite 632
city: Port Michaelafort
zipcode: '16804'
phone: (846)556-4478
state_name: New York
company: null
country_name: United States
country_iso3: USA
country_iso: US
state_code: NY
AddressList:
description: 200 Success - Returns an array of `address` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Address'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
Standard response:
value:
data:
- id: '11'
type: address
attributes:
firstname: Tyler
lastname: Durden
address1: 12312 Street
address2: Basment Entrance
city: LA
zipcode: '90210'
phone: '08173762736'
state_name: California
company: Paper Street Soap Co
country_name: United States
country_iso3: USA
country_iso: US
label: Home
state_code: CA
- id: '28'
type: address
attributes:
firstname: John
lastname: Snow
address1: 7735 Old Georgetown Road
address2: 2nd Floor
city: Bethesda
zipcode: '20814'
phone: '3014445002'
state_name: Maryland
company: null
country_name: United States
country_iso3: USA
country_iso: US
label: null
state_code: MD
- id: '29'
type: address
attributes:
firstname: Emma
lastname: Carragher
address1: 775645 Old Georgetown Road
address2: 3rd Floor
city: Qethesda
zipcode: '90210'
phone: '3488545445002'
state_name: California
company: null
country_name: United States
country_iso3: USA
country_iso: US
label: Work
state_code: CA
meta:
count: 3
total_count: 3
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/account/addresses'
next: 'http://localhost:3000/api/v2/storefront/account/addresses?page=1'
prev: 'http://localhost:3000/api/v2/storefront/account/addresses?page=1'
last: 'http://localhost:3000/api/v2/storefront/account/addresses?page=1'
first: 'http://localhost:3000/api/v2/storefront/account/addresses?page=1'
Address:
description: 200 Success - Returns the `address` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Address'
examples:
Standard response:
value:
data:
id: '29'
type: address
attributes:
firstname: Mark
lastname: Winterburn
address1: 775645 Old Georgetown Road
address2: 3rd Floor
city: Qethesda
zipcode: '90210'
phone: '3488545445002'
state_name: California
company: Paper Street Soap Co.
country_name: United States
country_iso3: USA
country_iso: US
label: Work
state_code: CA
CmsPage:
description: 200 Success - Returns the `cms_page` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CmsPage'
included:
type: array
items:
$ref: '#/components/schemas/CmsPageIncludes'
examples:
Standard Page:
value:
data:
id: '1'
type: cms_page
attributes:
title: About Us
content: Corporis consequuntur cumque dicta doloremque. Laborum corrupti nobis magni quos. Veniam ea laudantium tempora libero perferendis illum. Maiores maxime quibusdam quam porro omnis. Libero vitae nesciunt occaecati quasi ipsa laudantium deserunt fuga. Vitae ducimus optio dolorem aliquam inventore fugiat. Minima laborum illo aliquam quam fuga. Ducimus nam quis quo rerum.
locale: en
meta_description: null
meta_title: null
slug: about-us
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
Feature Page:
value:
data:
id: '25'
type: cms_page
attributes:
title: Feature Page
content: null
locale: en
meta_description: null
meta_title: null
slug: feature-page
type: 'Spree::Cms::Pages::FeaturePage'
relationships:
cms_sections:
data:
- id: '4'
type: cms_section
- id: '16'
type: cms_section
- id: '28'
type: cms_section
- id: '40'
type: cms_section
- id: '52'
type: cms_section
- id: '64'
type: cms_section
Feature Page with Includes:
value:
data:
id: '25'
type: cms_page
attributes:
title: Feature Page
content: null
locale: en
meta_description: null
meta_title: null
slug: feature-page
type: 'Spree::Cms::Pages::FeaturePage'
relationships:
cms_sections:
data:
- id: '4'
type: cms_section
- id: '16'
type: cms_section
- id: '28'
type: cms_section
- id: '40'
type: cms_section
- id: '52'
type: cms_section
- id: '64'
type: cms_section
included:
- id: '4'
type: cms_section
attributes:
name: Hero Image
content:
title: Summer Collection
button_text: Shop Now
settings:
gutters: No Gutters
link: /t/categories/new-collection/summer-2021
fit: Screen
type: 'Spree::Cms::Sections::HeroImage'
position: 1
img_one_sm: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRZd01IZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--5e6c4239964577906b395aaaea2b5b33fd26e5f3/main_banner_3.jpg
img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFeU1EQjROVEF3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--8f3058de34a7771ea1f07ef6e64153f565cbdb1d/main_banner_3.jpg
img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpJME1EQjRNVEF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--caf0125f9a50b49f356feec7152d61264d0f2a53/main_banner_3.jpg
img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpRNE1EQjRNakF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--f924ce193445aeae4c45f1f3841c0adf9d26db9b/main_banner_3.jpg
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '24'
type: taxon
- id: '16'
type: cms_section
attributes:
name: Main Taxons
content:
link_type_one: 'Spree::Taxon'
link_type_two: 'Spree::Taxon'
link_type_three: 'Spree::Taxon'
link_one: categories/men
link_two: categories/women
link_three: categories/sportswear
title_one: Men
title_two: Women
title_three: Sportswear
settings:
layout_style: Default
display_labels: Show
link: null
fit: Container
type: 'Spree::Cms::Sections::ImageGallery'
position: 2
img_one_sm: null
img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--74de5b2afe48f629a8e16d5b2d8944b3d3417bef/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--da678788156c69df71d3b9aef47b2381b97c0fe1/category_banner_upper-bf1d79fc1d5da2ba796d5cdacb2e65a5a89285c6f12d0fd3c4d1a50c635b8f49.jpg
img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--74de5b2afe48f629a8e16d5b2d8944b3d3417bef/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--02e56f1fb10afeb8bc7364c98c73e3645b516d9b/category_banner_upper-bf1d79fc1d5da2ba796d5cdacb2e65a5a89285c6f12d0fd3c4d1a50c635b8f49.jpg
img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--74de5b2afe48f629a8e16d5b2d8944b3d3417bef/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--16c4f4dbd2b4eada16a7c32ea369def68e06ec45/category_banner_upper-bf1d79fc1d5da2ba796d5cdacb2e65a5a89285c6f12d0fd3c4d1a50c635b8f49.jpg
img_two_sm: null
img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--3d636cee0e2ffe82cb99718d0676daa7a3da6c72/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZzBNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--483b55f9c18aa91cde294027bdf11e70c6de031b/big_category_banner-5308e3f568f948a5d71eb27746b573e0b3559200b1b21bb72dbc6bf69d2ce6de.jpg
img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--3d636cee0e2ffe82cb99718d0676daa7a3da6c72/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZzRNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9c77e106262988ecd2dc8f79220e4f5c7219a6f8/big_category_banner-5308e3f568f948a5d71eb27746b573e0b3559200b1b21bb72dbc6bf69d2ce6de.jpg
img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--3d636cee0e2ffe82cb99718d0676daa7a3da6c72/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpFd09EQjRNVFl3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--0f0060f3bf83404f48792c1187ec2b15743378ab/big_category_banner-5308e3f568f948a5d71eb27746b573e0b3559200b1b21bb72dbc6bf69d2ce6de.jpg
img_three_sm: null
img_three_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--b365318aa440b93e148b22ded1d0ab26b9115580/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--da678788156c69df71d3b9aef47b2381b97c0fe1/category_banner_lower-b0e4f3ef4fca77de099754d8b23ffd0410c31d127ad228116de7ff54235745dc.jpg
img_three_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--b365318aa440b93e148b22ded1d0ab26b9115580/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--02e56f1fb10afeb8bc7364c98c73e3645b516d9b/category_banner_lower-b0e4f3ef4fca77de099754d8b23ffd0410c31d127ad228116de7ff54235745dc.jpg
img_three_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--b365318aa440b93e148b22ded1d0ab26b9115580/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--16c4f4dbd2b4eada16a7c32ea369def68e06ec45/category_banner_lower-b0e4f3ef4fca77de099754d8b23ffd0410c31d127ad228116de7ff54235745dc.jpg
is_fullscreen: false
relationships:
linked_resource:
data: null
- id: '28'
type: cms_section
attributes:
name: Best Sellers Carousel
content: null
settings: null
link: /t/categories/bestsellers
fit: Screen
type: 'Spree::Cms::Sections::ProductCarousel'
position: 3
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '19'
type: taxon
- id: '40'
type: cms_section
attributes:
name: Fashion Trends
content:
title: Summer 2021
subtitle: Fashion Trends
button_text: Read More
rte_content: '
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.
'
settings:
gutters: No Gutters
link: /t/categories/trending
fit: Screen
type: 'Spree::Cms::Sections::FeaturedArticle'
position: 4
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '20'
type: taxon
- id: '52'
type: cms_section
attributes:
name: Trending Carousel
content: null
settings: null
link: /t/categories/trending
fit: Screen
type: 'Spree::Cms::Sections::ProductCarousel'
position: 5
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '20'
type: taxon
- id: '64'
type: cms_section
attributes:
name: Promotions
content:
link_type_one: 'Spree::Taxon'
link_type_two: 'Spree::Taxon'
title_one: New Collection
subtitle_one: Street Style
link_one: categories/streetstyle
title_two: Summer Sale
subtitle_two: Up To 30% OFF
link_two: categories/special-offers/30-percent-off
settings:
gutters: Gutters
link: null
fit: Container
type: 'Spree::Cms::Sections::SideBySideImages'
position: 6
img_one_sm: null
img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--bdd435f1da7adb1dfc741a7200d5e22b2fe1797d/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b3e83aeec90291ac43c84e93512729c510db19cc/streetstyle.jpg
img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--bdd435f1da7adb1dfc741a7200d5e22b2fe1797d/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--02e56f1fb10afeb8bc7364c98c73e3645b516d9b/streetstyle.jpg
img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--bdd435f1da7adb1dfc741a7200d5e22b2fe1797d/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--c6c3944ed27a762954c5b8b970acdab9b03d8356/streetstyle.jpg
img_two_sm: null
img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--477cb8277e7f6408a2b6f2495255605c733a2f56/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b3e83aeec90291ac43c84e93512729c510db19cc/sport_sweatshirt.jpg
img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--477cb8277e7f6408a2b6f2495255605c733a2f56/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRjek5IZzBOelkrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--45ba177f161cea07721d348189b773edd3466278/sport_sweatshirt.jpg
img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--477cb8277e7f6408a2b6f2495255605c733a2f56/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--c6c3944ed27a762954c5b8b970acdab9b03d8356/sport_sweatshirt.jpg
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: false
relationships:
linked_resource:
data: null
CmsPageList:
description: 200 Success - Returns an array of `cms_page` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CmsPage'
included:
type: array
items:
$ref: '#/components/schemas/CmsPageIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
CMS Pages:
value:
data:
- id: '1'
type: cms_page
attributes:
title: About Us
content: Corporis consequuntur cumque dicta doloremque. Laborum corrupti nobis magni quos. Veniam ea laudantium tempora libero perferendis illum. Maiores maxime quibusdam quam porro omnis. Libero vitae nesciunt occaecati quasi ipsa laudantium deserunt fuga. Vitae ducimus optio dolorem aliquam inventore fugiat. Minima laborum illo aliquam quam fuga. Ducimus nam quis quo rerum.
locale: en
meta_description: null
meta_title: null
slug: about-us
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '2'
type: cms_page
attributes:
title: Privacy Policy
content: Veniam quasi atque facilis soluta sed corporis. Dignissimos repudiandae aut eos deserunt cupiditate optio nemo neque. Perferendis cupiditate nemo tempora unde quasi beatae sapiente. Illum ipsum adipisci ducimus facilis culpa sunt. Optio quam atque dolorum vero deserunt harum. Saepe eveniet laborum hic vel adipisci maxime. Sit repudiandae iusto totam reprehenderit. Repellendus assumenda blanditiis repellat similique eaque. Illo cumque omnis maiores ex praesentium illum. Voluptates eveniet nulla tempore debitis alias ullam pariatur.
locale: en
meta_description: null
meta_title: null
slug: privacy-policy
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '3'
type: cms_page
attributes:
title: Shipping Policy
content: Ab dignissimos perspiciatis blanditiis laborum ipsum. Amet quo laborum vitae incidunt vero error neque. Eius aspernatur sit suscipit minima minus. Iste cupiditate nulla laudantium labore inventore magni. Nemo ipsam quasi consectetur cupiditate iure facilis mollitia. Quos earum cumque recusandae aliquam quasi labore. Autem magni libero eaque vitae veritatis. Sequi vitae amet accusantium perspiciatis adipisci. Dolorem aspernatur veritatis ad consequuntur aliquam sapiente autem necessitatibus.
locale: en
meta_description: null
meta_title: null
slug: shipping-policy
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '4'
type: cms_page
attributes:
title: Returns Policy
content: Reiciendis ut repellendus sed explicabo. Omnis hic excepturi officia itaque deserunt. Eos reiciendis recusandae dignissimos asperiores sint. Quisquam temporibus repellendus quod reiciendis rem laborum harum perspiciatis. Nemo nesciunt dolore dicta libero officiis suscipit natus. Impedit sit corporis dolores quibusdam voluptates cum. Commodi asperiores reprehenderit placeat quisquam sed. Voluptas architecto adipisci dolorum officia voluptatem.
locale: en
meta_description: null
meta_title: null
slug: returns-policy
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '31'
type: cms_page
attributes:
title: Homepage (English)
content: null
locale: en
meta_description: null
meta_title: null
slug: null
type: 'Spree::Cms::Pages::Homepage'
relationships:
cms_sections:
data:
- id: '10'
type: cms_section
- id: '22'
type: cms_section
- id: '34'
type: cms_section
- id: '46'
type: cms_section
- id: '58'
type: cms_section
- id: '70'
type: cms_section
- id: '25'
type: cms_page
attributes:
title: Feature Page
content: null
locale: en
meta_description: null
meta_title: null
slug: feature-page
type: 'Spree::Cms::Pages::FeaturePage'
relationships:
cms_sections:
data:
- id: '4'
type: cms_section
- id: '16'
type: cms_section
- id: '28'
type: cms_section
- id: '40'
type: cms_section
- id: '52'
type: cms_section
- id: '64'
type: cms_section
meta:
count: 6
total_count: 6
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/cms_pages'
next: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
prev: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
last: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
first: 'http://localhost:3000/api/v2/storefront/cms_pages?page=1'
CMS Pages with Included Sections:
value:
data:
- id: '1'
type: cms_page
attributes:
title: About Us
content: Corporis consequuntur cumque dicta doloremque. Laborum corrupti nobis magni quos. Veniam ea laudantium tempora libero perferendis illum. Maiores maxime quibusdam quam porro omnis. Libero vitae nesciunt occaecati quasi ipsa laudantium deserunt fuga. Vitae ducimus optio dolorem aliquam inventore fugiat. Minima laborum illo aliquam quam fuga. Ducimus nam quis quo rerum.
locale: en
meta_description: null
meta_title: null
slug: about-us
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '2'
type: cms_page
attributes:
title: Privacy Policy
content: Veniam quasi atque facilis soluta sed corporis. Dignissimos repudiandae aut eos deserunt cupiditate optio nemo neque. Perferendis cupiditate nemo tempora unde quasi beatae sapiente. Illum ipsum adipisci ducimus facilis culpa sunt. Optio quam atque dolorum vero deserunt harum. Saepe eveniet laborum hic vel adipisci maxime. Sit repudiandae iusto totam reprehenderit. Repellendus assumenda blanditiis repellat similique eaque. Illo cumque omnis maiores ex praesentium illum. Voluptates eveniet nulla tempore debitis alias ullam pariatur.
locale: en
meta_description: null
meta_title: null
slug: privacy-policy
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '3'
type: cms_page
attributes:
title: Shipping Policy
content: Ab dignissimos perspiciatis blanditiis laborum ipsum. Amet quo laborum vitae incidunt vero error neque. Eius aspernatur sit suscipit minima minus. Iste cupiditate nulla laudantium labore inventore magni. Nemo ipsam quasi consectetur cupiditate iure facilis mollitia. Quos earum cumque recusandae aliquam quasi labore. Autem magni libero eaque vitae veritatis. Sequi vitae amet accusantium perspiciatis adipisci. Dolorem aspernatur veritatis ad consequuntur aliquam sapiente autem necessitatibus.
locale: en
meta_description: null
meta_title: null
slug: shipping-policy
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '4'
type: cms_page
attributes:
title: Returns Policy
content: Reiciendis ut repellendus sed explicabo. Omnis hic excepturi officia itaque deserunt. Eos reiciendis recusandae dignissimos asperiores sint. Quisquam temporibus repellendus quod reiciendis rem laborum harum perspiciatis. Nemo nesciunt dolore dicta libero officiis suscipit natus. Impedit sit corporis dolores quibusdam voluptates cum. Commodi asperiores reprehenderit placeat quisquam sed. Voluptas architecto adipisci dolorum officia voluptatem.
locale: en
meta_description: null
meta_title: null
slug: returns-policy
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '31'
type: cms_page
attributes:
title: Homepage (English)
content: null
locale: en
meta_description: null
meta_title: null
slug: null
type: 'Spree::Cms::Pages::Homepage'
relationships:
cms_sections:
data:
- id: '10'
type: cms_section
- id: '22'
type: cms_section
- id: '34'
type: cms_section
- id: '46'
type: cms_section
- id: '58'
type: cms_section
- id: '70'
type: cms_section
- id: '25'
type: cms_page
attributes:
title: Feature Page
content: null
locale: en
meta_description: null
meta_title: null
slug: feature-page
type: 'Spree::Cms::Pages::FeaturePage'
relationships:
cms_sections:
data:
- id: '4'
type: cms_section
- id: '16'
type: cms_section
- id: '28'
type: cms_section
- id: '40'
type: cms_section
- id: '52'
type: cms_section
- id: '64'
type: cms_section
included:
- id: '10'
type: cms_section
attributes:
name: Hero Image
content:
title: Summer Collection
button_text: Shop Now
settings:
gutters: No Gutters
link: /t/categories/new-collection/summer-2021
fit: Screen
type: 'Spree::Cms::Sections::HeroImage'
position: 1
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '24'
type: taxon
- id: '22'
type: cms_section
attributes:
name: Main Taxons
content:
link_type_one: 'Spree::Taxon'
link_type_two: 'Spree::Taxon'
link_type_three: 'Spree::Taxon'
link_one: categories/men
link_two: categories/women
link_three: categories/sportswear
title_one: Men
title_two: Women
title_three: Sportswear
settings:
layout_style: Default
link: null
fit: Container
type: 'Spree::Cms::Sections::ImageGallery'
position: 2
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: false
relationships:
linked_resource:
data: null
- id: '34'
type: cms_section
attributes:
name: Best Sellers Carousel
content: null
settings: null
link: /t/categories/bestsellers
fit: Screen
type: 'Spree::Cms::Sections::ProductCarousel'
position: 3
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '19'
type: taxon
- id: '46'
type: cms_section
attributes:
name: Fashion Trends
content:
title: Summer 2021
subtitle: Fashion Trends
button_text: Read More
rte_content: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.
'
settings:
gutters: No Gutters
link: /t/categories/trending
fit: Screen
type: 'Spree::Cms::Sections::FeaturedArticle'
position: 4
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '20'
type: taxon
- id: '58'
type: cms_section
attributes:
name: Trending Carousel
content: null
settings: null
link: /t/categories/trending
fit: Screen
type: 'Spree::Cms::Sections::ProductCarousel'
position: 5
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '20'
type: taxon
- id: '70'
type: cms_section
attributes:
name: Promotions
content:
link_type_one: 'Spree::Taxon'
link_type_two: 'Spree::Taxon'
title_one: New Collection
subtitle_one: Street Style
link_one: categories/streetstyle
title_two: Summer Sale
subtitle_two: Up To 30% OFF
link_two: categories/special-offers/30-percent-off
settings:
gutters: Gutters
link: null
fit: Container
type: 'Spree::Cms::Sections::SideBySideImages'
position: 6
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: false
relationships:
linked_resource:
data: null
- id: '4'
type: cms_section
attributes:
name: Hero Image
content:
title: Summer Collection
button_text: Shop Now
settings:
gutters: No Gutters
link: /t/categories/new-collection/summer-2021
fit: Screen
type: 'Spree::Cms::Sections::HeroImage'
position: 1
img_one_sm: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRZd01IZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--5e6c4239964577906b395aaaea2b5b33fd26e5f3/main_banner_3.jpg
img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFeU1EQjROVEF3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--8f3058de34a7771ea1f07ef6e64153f565cbdb1d/main_banner_3.jpg
img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpJME1EQjRNVEF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--caf0125f9a50b49f356feec7152d61264d0f2a53/main_banner_3.jpg
img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBCZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--67eaa93fa73d2f928bab365d457bab4c213237ee/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpRNE1EQjRNakF3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--f924ce193445aeae4c45f1f3841c0adf9d26db9b/main_banner_3.jpg
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '24'
type: taxon
- id: '16'
type: cms_section
attributes:
name: Main Taxons
content:
link_type_one: 'Spree::Taxon'
link_type_two: 'Spree::Taxon'
link_type_three: 'Spree::Taxon'
link_one: categories/men
link_two: categories/women
link_three: categories/sportswear
title_one: Men
title_two: Women
title_three: Sportswear
settings:
layout_style: Default
display_labels: Show
link: null
fit: Container
type: 'Spree::Cms::Sections::ImageGallery'
position: 2
img_one_sm: null
img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--74de5b2afe48f629a8e16d5b2d8944b3d3417bef/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--da678788156c69df71d3b9aef47b2381b97c0fe1/category_banner_upper-bf1d79fc1d5da2ba796d5cdacb2e65a5a89285c6f12d0fd3c4d1a50c635b8f49.jpg
img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--74de5b2afe48f629a8e16d5b2d8944b3d3417bef/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--02e56f1fb10afeb8bc7364c98c73e3645b516d9b/category_banner_upper-bf1d79fc1d5da2ba796d5cdacb2e65a5a89285c6f12d0fd3c4d1a50c635b8f49.jpg
img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDUT09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--74de5b2afe48f629a8e16d5b2d8944b3d3417bef/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--16c4f4dbd2b4eada16a7c32ea369def68e06ec45/category_banner_upper-bf1d79fc1d5da2ba796d5cdacb2e65a5a89285c6f12d0fd3c4d1a50c635b8f49.jpg
img_two_sm: null
img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--3d636cee0e2ffe82cb99718d0676daa7a3da6c72/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZzBNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--483b55f9c18aa91cde294027bdf11e70c6de031b/big_category_banner-5308e3f568f948a5d71eb27746b573e0b3559200b1b21bb72dbc6bf69d2ce6de.jpg
img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--3d636cee0e2ffe82cb99718d0676daa7a3da6c72/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZzRNREErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--9c77e106262988ecd2dc8f79220e4f5c7219a6f8/big_category_banner-5308e3f568f948a5d71eb27746b573e0b3559200b1b21bb72dbc6bf69d2ce6de.jpg
img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--3d636cee0e2ffe82cb99718d0676daa7a3da6c72/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRHpFd09EQjRNVFl3TUQ0R093WlUiLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--0f0060f3bf83404f48792c1187ec2b15743378ab/big_category_banner-5308e3f568f948a5d71eb27746b573e0b3559200b1b21bb72dbc6bf69d2ce6de.jpg
img_three_sm: null
img_three_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--b365318aa440b93e148b22ded1d0ab26b9115580/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRJM01IZ3hPVFUrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--da678788156c69df71d3b9aef47b2381b97c0fe1/category_banner_lower-b0e4f3ef4fca77de099754d8b23ffd0410c31d127ad228116de7ff54235745dc.jpg
img_three_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--b365318aa440b93e148b22ded1d0ab26b9115580/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--02e56f1fb10afeb8bc7364c98c73e3645b516d9b/category_banner_lower-b0e4f3ef4fca77de099754d8b23ffd0410c31d127ad228116de7ff54235745dc.jpg
img_three_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--b365318aa440b93e148b22ded1d0ab26b9115580/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFd09EQjROemd3UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--16c4f4dbd2b4eada16a7c32ea369def68e06ec45/category_banner_lower-b0e4f3ef4fca77de099754d8b23ffd0410c31d127ad228116de7ff54235745dc.jpg
is_fullscreen: false
relationships:
linked_resource:
data: null
- id: '28'
type: cms_section
attributes:
name: Best Sellers Carousel
content: null
settings: null
link: /t/categories/bestsellers
fit: Screen
type: 'Spree::Cms::Sections::ProductCarousel'
position: 3
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '19'
type: taxon
- id: '40'
type: cms_section
attributes:
name: Fashion Trends
content:
title: Summer 2021
subtitle: Fashion Trends
button_text: Read More
rte_content: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam.
'
settings:
gutters: No Gutters
link: /t/categories/trending
fit: Screen
type: 'Spree::Cms::Sections::FeaturedArticle'
position: 4
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '20'
type: taxon
- id: '52'
type: cms_section
attributes:
name: Trending Carousel
content: null
settings: null
link: /t/categories/trending
fit: Screen
type: 'Spree::Cms::Sections::ProductCarousel'
position: 5
img_one_sm: null
img_one_md: null
img_one_lg: null
img_one_xl: null
img_two_sm: null
img_two_md: null
img_two_lg: null
img_two_xl: null
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: true
relationships:
linked_resource:
data:
id: '20'
type: taxon
- id: '64'
type: cms_section
attributes:
name: Promotions
content:
link_type_one: 'Spree::Taxon'
link_type_two: 'Spree::Taxon'
title_one: New Collection
subtitle_one: Street Style
link_one: categories/streetstyle
title_two: Summer Sale
subtitle_two: Up To 30% OFF
link_two: categories/special-offers/30-percent-off
settings:
gutters: Gutters
link: null
fit: Container
type: 'Spree::Cms::Sections::SideBySideImages'
position: 6
img_one_sm: null
img_one_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--bdd435f1da7adb1dfc741a7200d5e22b2fe1797d/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b3e83aeec90291ac43c84e93512729c510db19cc/streetstyle.jpg
img_one_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--bdd435f1da7adb1dfc741a7200d5e22b2fe1797d/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRVME1IZ3pPVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--02e56f1fb10afeb8bc7364c98c73e3645b516d9b/streetstyle.jpg
img_one_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFZz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--bdd435f1da7adb1dfc741a7200d5e22b2fe1797d/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--c6c3944ed27a762954c5b8b970acdab9b03d8356/streetstyle.jpg
img_two_sm: null
img_two_md: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--477cb8277e7f6408a2b6f2495255605c733a2f56/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRNNE4zZ3lOVEErQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--b3e83aeec90291ac43c84e93512729c510db19cc/sport_sweatshirt.jpg
img_two_lg: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--477cb8277e7f6408a2b6f2495255605c733a2f56/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRFRjek5IZzBOelkrQmpzR1ZBPT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--45ba177f161cea07721d348189b773edd3466278/sport_sweatshirt.jpg
img_two_xl: /rails/active_storage/representations/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBFdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--477cb8277e7f6408a2b6f2495255605c733a2f56/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdCem9MWm05eWJXRjBTU0lJYW5CbkJqb0dSVlE2QzNKbGMybDZaVWtpRGpFME5qaDRPVFV5UGdZN0JsUT0iLCJleHAiOm51bGwsInB1ciI6InZhcmlhdGlvbiJ9fQ==--c6c3944ed27a762954c5b8b970acdab9b03d8356/sport_sweatshirt.jpg
img_three_sm: null
img_three_md: null
img_three_lg: null
img_three_xl: null
is_fullscreen: false
relationships:
linked_resource:
data: null
meta:
count: 6
total_count: 6
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections'
next: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
prev: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
last: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
first: 'http://localhost:3000/api/v2/storefront/cms_pages?include=cms_sections&page=1'
CreditCard:
description: 200 Success - Returns the `credit_card` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CreditCard'
included:
type: array
items:
$ref: '#/components/schemas/CreditCardIncludes'
required:
- data
examples:
Credit Card:
value:
data:
id: '1'
type: credit_card
attributes:
cc_type: visa
last_digits: '4111'
month: 12
year: 2026
name: John Doe
default: true
relationships:
payment_method:
data:
id: '1'
type: payment_method
included:
- id: '1'
type: payment_method
attributes:
type: 'Spree::Gateway::StripeGateway'
name: Stripe
description: Stripe Payments
preferences: {}
CreditCardList:
description: 200 Success - Returns an array of `credit_card` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CreditCard'
included:
type: array
items:
$ref: '#/components/schemas/CreditCardIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
List of Credit Cards:
value:
data:
- id: '1'
type: credit_card
attributes:
cc_type: visa
last_digits: '1111'
month: 12
year: 2026
name: John Doe
default: true
relationships:
payment_method:
data:
id: string
type: string
- id: '2'
type: credit_card
attributes:
cc_type: mastercard
last_digits: '6695'
month: 12
year: 2030
name: John Doe
default: false
relationships:
payment_method:
data:
id: string
type: string
included:
- id: '1'
type: payment_method
attributes:
type: 'Spree::Gateway::StripeGateway'
name: Stripe
description: Stripe Payments
preferences: {}
meta:
count: 2
total_count: 2
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/account/credit_cards'
next: 'http://localhost:3000/api/v2/storefront/account/credit_cards?page=0'
prev: 'http://localhost:3000/api/v2/storefront/account/credit_cards?page=1'
last: 'http://localhost:3000/api/v2/storefront/account/credit_cards?page=0'
first: 'http://localhost:3000/api/v2/storefront/account/credit_cards?page=1'
Product:
description: 200 Success - Returns the `product` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Product'
included:
type: array
items:
$ref: '#/components/schemas/ProductIncludes'
required:
- data
examples:
Single Product:
value:
data:
id: '96'
type: product
attributes:
name: Bomber Jacket
description: Dolorem nulla odit nostrum placeat soluta non vitae praesentium. Neque asperiores quos necessitatibus sint placeat. Voluptas aliquid atque veniam iste assumenda blanditiis. Excepturi odit recusandae laboriosam sunt temporibus corrupti. Tempore necessitatibus recusandae eligendi occaecati nesciunt sed illum similique.
available_on: '2021-10-02T11:02:29.288Z'
slug: bomber-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.681Z'
sku: JacketsandCoats_bomberjacket_38.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '38.99'
display_price: $38.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '212'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '639'
type: product_property
- id: '640'
type: product_property
- id: '641'
type: product_property
- id: '642'
type: product_property
- id: '643'
type: product_property
- id: '644'
type: product_property
- id: '645'
type: product_property
- id: '646'
type: product_property
taxons:
data:
- id: '19'
type: taxon
- id: '14'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '212'
type: variant
primary_variant:
data:
id: '96'
type: variant
Product with Includes:
value:
data:
id: '96'
type: product
attributes:
name: Bomber Jacket
description: Dolorem nulla odit nostrum placeat soluta non vitae praesentium. Neque asperiores quos necessitatibus sint placeat. Voluptas aliquid atque veniam iste assumenda blanditiis. Excepturi odit recusandae laboriosam sunt temporibus corrupti. Tempore necessitatibus recusandae eligendi occaecati nesciunt sed illum similique.
available_on: '2021-10-02T11:02:29.288Z'
slug: bomber-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.681Z'
sku: JacketsandCoats_bomberjacket_38.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '38.99'
display_price: $38.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '212'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '639'
type: product_property
- id: '640'
type: product_property
- id: '641'
type: product_property
- id: '642'
type: product_property
- id: '643'
type: product_property
- id: '644'
type: product_property
- id: '645'
type: product_property
- id: '646'
type: product_property
taxons:
data:
- id: '19'
type: taxon
- id: '14'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '212'
type: variant
primary_variant:
data:
id: '96'
type: variant
included:
- id: '212'
type: variant
attributes:
sku: JacketsandCoats_bomberjacket_38.99_khaki_xs
weight: '0.0'
height: null
width: null
depth: null
is_master: false
options_text: 'Color: khaki, Size: XS'
purchasable: true
in_stock: true
backorderable: false
currency: USD
price: '38.99'
display_price: $38.99
compare_at_price: null
display_compare_at_price: null
relationships:
product:
data:
id: '96'
type: product
images:
data: []
option_values:
data:
- id: '14'
type: option_value
- id: '23'
type: option_value
- id: '19'
type: taxon
attributes:
name: Bestsellers
pretty_name: Categories -> Bestsellers
permalink: categories/bestsellers
seo_title: Bestsellers
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 36
right: 37
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.082Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '14'
type: taxon
attributes:
name: Jackets and Coats
pretty_name: Categories -> Women -> Jackets and Coats
permalink: categories/women/jackets-and-coats
seo_title: Jackets and Coats
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 23
right: 24
position: 0
depth: 2
updated_at: '2021-10-02T11:03:14.688Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '3'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '24'
type: taxon
attributes:
name: Summer 2021
pretty_name: Categories -> New Collection -> Summer 2021
permalink: categories/new-collection/summer-2021
seo_title: Summer 2021
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 45
right: 46
position: 0
depth: 2
updated_at: '2021-10-02T11:03:15.001Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '23'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '3'
type: taxon
attributes:
name: Women
pretty_name: Categories -> Women
permalink: categories/women
seo_title: Women
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 12
right: 25
position: 0
depth: 1
updated_at: '2021-10-02T11:03:14.688Z'
is_root: false
is_child: true
is_leaf: false
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data:
- id: '9'
type: taxon
- id: '10'
type: taxon
- id: '11'
type: taxon
- id: '12'
type: taxon
- id: '13'
type: taxon
- id: '14'
type: taxon
image:
data: null
ProductList:
description: 200 Success - Returns an array of `product` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Product'
included:
type: array
items:
$ref: '#/components/schemas/CreditCardIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
List of Products:
value:
data:
- id: '96'
type: product
attributes:
name: Bomber Jacket
description: Dolorem nulla odit nostrum placeat soluta non vitae praesentium. Neque asperiores quos necessitatibus sint placeat. Voluptas aliquid atque veniam iste assumenda blanditiis. Excepturi odit recusandae laboriosam sunt temporibus corrupti. Tempore necessitatibus recusandae eligendi occaecati nesciunt sed illum similique.
available_on: '2021-10-02T11:02:29.288Z'
slug: bomber-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.681Z'
sku: JacketsandCoats_bomberjacket_38.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '38.99'
display_price: $38.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '212'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '639'
type: product_property
- id: '640'
type: product_property
- id: '641'
type: product_property
- id: '642'
type: product_property
- id: '643'
type: product_property
- id: '644'
type: product_property
- id: '645'
type: product_property
- id: '646'
type: product_property
taxons:
data:
- id: '19'
type: taxon
- id: '14'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '212'
type: variant
primary_variant:
data:
id: '96'
type: variant
- id: '97'
type: product
attributes:
name: Sports Bra Low Support
description: Consequuntur deserunt ex asperiores maiores repudiandae tenetur. Recusandae labore cupiditate aliquid voluptatibus at. Culpa repellendus veritatis ad aliquam eligendi reprehenderit corporis.
available_on: '2021-10-02T11:02:29.414Z'
slug: sports-bra-low-support
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.710Z'
sku: Tops_sportsbralowsupport_61.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '61.99'
display_price: $61.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '213'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '647'
type: product_property
- id: '648'
type: product_property
- id: '649'
type: product_property
- id: '650'
type: product_property
- id: '651'
type: product_property
- id: '652'
type: product_property
- id: '653'
type: product_property
- id: '654'
type: product_property
taxons:
data:
- id: '19'
type: taxon
- id: '4'
type: taxon
- id: '15'
type: taxon
- id: '20'
type: taxon
- id: '18'
type: taxon
images:
data: []
default_variant:
data:
id: '213'
type: variant
primary_variant:
data:
id: '97'
type: variant
- id: '48'
type: product
attributes:
name: Flared Dress
description: Ut ullam aspernatur facere dicta explicabo sed. Molestiae nihil atque sed voluptatibus officiis. Aspernatur vitae nesciunt non doloremque. Officiis velit et magnam molestias repellat. Asperiores modi totam labore iure aperiam sequi.
available_on: '2021-10-02T11:02:23.076Z'
slug: flared-dress
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.159Z'
sku: Dresses_flareddress_21.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '21.99'
display_price: $21.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '164'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '2'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '387'
type: product_property
- id: '388'
type: product_property
- id: '389'
type: product_property
- id: '390'
type: product_property
- id: '391'
type: product_property
- id: '392'
type: product_property
- id: '393'
type: product_property
- id: '394'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '18'
type: taxon
- id: '10'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '164'
type: variant
primary_variant:
data:
id: '48'
type: variant
- id: '115'
type: product
attributes:
name: High Waist Pants With Pockets
description: Doloribus ipsam beatae porro aspernatur officiis aperiam. Sapiente quos commodi vitae incidunt. Architecto ducimus iste sed laudantium.
available_on: '2021-10-02T11:02:31.782Z'
slug: high-waist-pants-with-pockets
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.537Z'
sku: Pants_highwaistpantswithpockets_69.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '69.99'
display_price: $69.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '231'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '775'
type: product_property
- id: '776'
type: product_property
- id: '777'
type: product_property
- id: '778'
type: product_property
- id: '779'
type: product_property
- id: '780'
type: product_property
- id: '781'
type: product_property
- id: '782'
type: product_property
taxons:
data:
- id: '17'
type: taxon
- id: '4'
type: taxon
- id: '20'
type: taxon
images:
data: []
default_variant:
data:
id: '231'
type: variant
primary_variant:
data:
id: '115'
type: variant
- id: '94'
type: product
attributes:
name: Wool Blend Coat With Belt
description: Aspernatur aperiam est id odio rerum eveniet optio. Aspernatur odio quisquam soluta explicabo. Numquam ipsam sint magni ducimus eum. Voluptas excepturi tenetur optio culpa asperiores facilis sapiente.
available_on: '2021-10-02T11:02:29.039Z'
slug: wool-blend-coat-with-belt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.622Z'
sku: JacketsandCoats_wool-blendcoatwithbelt_30.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '30.99'
display_price: $30.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '210'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '623'
type: product_property
- id: '624'
type: product_property
- id: '625'
type: product_property
- id: '626'
type: product_property
- id: '627'
type: product_property
- id: '628'
type: product_property
- id: '629'
type: product_property
- id: '630'
type: product_property
taxons:
data:
- id: '14'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '210'
type: variant
primary_variant:
data:
id: '94'
type: variant
- id: '4'
type: product
attributes:
name: Slim Fit Shirt
description: Quidem accusamus similique blanditiis dolores corrupti. Laborum sed facere a expedita porro. Aperiam sint aspernatur eos dolore quod suscipit. Repudiandae tempore dolorum itaque repellat rerum doloremque cupiditate.
available_on: '2021-10-02T11:02:17.586Z'
slug: slim-fit-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.806Z'
sku: Shirts_slimfitshirt_62.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '62.99'
display_price: $62.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '120'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '153'
type: product_property
- id: '154'
type: product_property
- id: '155'
type: product_property
- id: '156'
type: product_property
- id: '157'
type: product_property
- id: '158'
type: product_property
- id: '159'
type: product_property
- id: '160'
type: product_property
taxons:
data:
- id: '19'
type: taxon
- id: '5'
type: taxon
- id: '2'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '120'
type: variant
primary_variant:
data:
id: '4'
type: variant
- id: '106'
type: product
attributes:
name: Lightweight Running Jacket
description: Ipsum dolorum quo fugit reiciendis quae cupiditate. Quas incidunt adipisci iure quasi quaerat in laborum animi. Quo molestiae aperiam officiis provident voluptates a nesciunt.
available_on: '2021-10-02T11:02:30.674Z'
slug: Lightweight-running-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.967Z'
sku: Sweatshirts_Lightweightrunningjacket_10.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '10.99'
display_price: $10.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '222'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '703'
type: product_property
- id: '704'
type: product_property
- id: '705'
type: product_property
- id: '706'
type: product_property
- id: '707'
type: product_property
- id: '708'
type: product_property
- id: '709'
type: product_property
- id: '710'
type: product_property
taxons:
data:
- id: '16'
type: taxon
- id: '4'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '222'
type: variant
primary_variant:
data:
id: '106'
type: variant
- id: '21'
type: product
attributes:
name: Stripped Jumper
description: Placeat nemo vel molestiae sequi totam optio. Eaque distinctio incidunt blanditiis saepe voluptate. Ullam officia est nobis dolor. Facilis quam voluptas provident vero dolores. Nam consequuntur velit dolores recusandae excepturi veniam.
available_on: '2021-10-02T11:02:19.687Z'
slug: stripped-jumper
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.299Z'
sku: Sweaters_strippedjumper_84.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '84.99'
display_price: $84.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '137'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '211'
type: product_property
- id: '212'
type: product_property
- id: '213'
type: product_property
- id: '214'
type: product_property
- id: '215'
type: product_property
- id: '216'
type: product_property
- id: '217'
type: product_property
- id: '218'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '2'
type: taxon
- id: '7'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '137'
type: variant
primary_variant:
data:
id: '21'
type: variant
- id: '25'
type: product
attributes:
name: Hoodie
description: Harum iusto atque consequuntur rem. Dolor incidunt quae eveniet sequi tempore illo unde quia. Quos aperiam incidunt doloribus eum amet animi. Saepe rerum dolorum molestias eos.
available_on: '2021-10-02T11:02:20.175Z'
slug: hoodie
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.418Z'
sku: Sweaters_hoodie_17.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '17.99'
display_price: $17.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '141'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '243'
type: product_property
- id: '244'
type: product_property
- id: '245'
type: product_property
- id: '246'
type: product_property
- id: '247'
type: product_property
- id: '248'
type: product_property
- id: '249'
type: product_property
- id: '250'
type: product_property
taxons:
data:
- id: '2'
type: taxon
- id: '7'
type: taxon
- id: '26'
type: taxon
images:
data: []
default_variant:
data:
id: '141'
type: variant
primary_variant:
data:
id: '25'
type: variant
- id: '66'
type: product
attributes:
name: Floral Shirt
description: Veritatis alias dolores accusamus quaerat ipsa. Ab quibusdam provident necessitatibus deserunt rerum. Eaque laborum ducimus labore earum aspernatur sit nisi. Soluta amet earum provident blanditiis ut quibusdam facilis labore. Nihil commodi eaque assumenda quibusdam debitis autem laborum.
available_on: '2021-10-02T11:02:25.553Z'
slug: floral-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.668Z'
sku: ShirtsandBlouses_floralshirt_41.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '41.99'
display_price: $41.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '182'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '499'
type: product_property
- id: '500'
type: product_property
- id: '501'
type: product_property
- id: '502'
type: product_property
- id: '503'
type: product_property
- id: '504'
type: product_property
- id: '505'
type: product_property
- id: '506'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '11'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '182'
type: variant
primary_variant:
data:
id: '66'
type: variant
- id: '74'
type: product
attributes:
name: Knitted V Neck Sweater
description: Eum aperiam qui modi molestiae nesciunt iusto. Vero qui reprehenderit iure aut voluptates. In fugiat non sequi neque excepturi.
available_on: '2021-10-02T11:02:26.556Z'
slug: knitted-v-neck-sweater
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.911Z'
sku: Sweaters_knittedv-necksweater_30.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '30.99'
display_price: $30.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '190'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '555'
type: product_property
- id: '556'
type: product_property
- id: '557'
type: product_property
- id: '558'
type: product_property
- id: '559'
type: product_property
- id: '560'
type: product_property
- id: '561'
type: product_property
- id: '562'
type: product_property
taxons:
data:
- id: '12'
type: taxon
- id: '21'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '190'
type: variant
primary_variant:
data:
id: '74'
type: variant
- id: '19'
type: product
attributes:
name: Basic T Shirt
description: Architecto illum dolorum porro aut hic sint aliquid odit. Nisi suscipit vero non eaque sunt. Dicta neque voluptatem sequi explicabo unde occaecati eius. Ad optio eaque consectetur iusto consequatur consequuntur. Molestiae dolor occaecati pariatur perspiciatis.
available_on: '2021-10-02T11:02:19.439Z'
slug: basic-t-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.234Z'
sku: T-shirts_basict-shirt_56.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '56.99'
display_price: $56.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '135'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '57'
type: product_property
- id: '58'
type: product_property
- id: '59'
type: product_property
- id: '60'
type: product_property
- id: '61'
type: product_property
- id: '62'
type: product_property
- id: '63'
type: product_property
- id: '64'
type: product_property
- id: '209'
type: product_property
- id: '210'
type: product_property
taxons:
data:
- id: '6'
type: taxon
- id: '18'
type: taxon
- id: '2'
type: taxon
- id: '24'
type: taxon
- id: '21'
type: taxon
images:
data: []
default_variant:
data:
id: '135'
type: variant
primary_variant:
data:
id: '19'
type: variant
- id: '52'
type: product
attributes:
name: Printed Dress
description: Inventore perferendis assumenda quia libero dolore error quam occaecati. Eaque distinctio magnam ut aut voluptas facere. Perferendis qui adipisci dolor praesentium harum. Saepe unde voluptates nemo occaecati voluptas assumenda tempore. Adipisci voluptates at corporis ab sed sequi.
available_on: '2021-10-02T11:02:23.730Z'
slug: printed-dress
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.274Z'
sku: Dresses_printeddress_86.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '86.99'
display_price: $86.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '168'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '2'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '411'
type: product_property
- id: '412'
type: product_property
- id: '413'
type: product_property
- id: '414'
type: product_property
- id: '415'
type: product_property
- id: '416'
type: product_property
- id: '417'
type: product_property
- id: '418'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '10'
type: taxon
- id: '24'
type: taxon
- id: '21'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '168'
type: variant
primary_variant:
data:
id: '52'
type: variant
- id: '102'
type: product
attributes:
name: Sports Bra Medium Support
description: Architecto dolores ullam sed labore. Omnis excepturi occaecati ipsa ullam facere voluptatum quis. Saepe dignissimos quia facere repudiandae minus distinctio. Quo blanditiis eveniet accusamus rem maiores dolore cum.
available_on: '2021-10-02T11:02:30.172Z'
slug: sports-bra-medium-support
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.852Z'
sku: Tops_sportsbramediumsupport_90.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '90.99'
display_price: $90.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '218'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '679'
type: product_property
- id: '680'
type: product_property
- id: '681'
type: product_property
- id: '682'
type: product_property
- id: '683'
type: product_property
- id: '684'
type: product_property
- id: '685'
type: product_property
- id: '686'
type: product_property
taxons:
data:
- id: '19'
type: taxon
- id: '4'
type: taxon
- id: '15'
type: taxon
- id: '18'
type: taxon
- id: '26'
type: taxon
images:
data: []
default_variant:
data:
id: '218'
type: variant
primary_variant:
data:
id: '102'
type: variant
- id: '71'
type: product
attributes:
name: Oversized Knitted Sweater
description: Fuga nam provident beatae odio. Est vitae cum fuga corrupti delectus. Officiis harum nulla debitis ut.
available_on: '2021-10-02T11:02:26.186Z'
slug: oversized-knitted-sweater
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.821Z'
sku: Sweaters_oversizedknittedsweater_10.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '10.99'
display_price: $10.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '187'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '531'
type: product_property
- id: '532'
type: product_property
- id: '533'
type: product_property
- id: '534'
type: product_property
- id: '535'
type: product_property
- id: '536'
type: product_property
- id: '537'
type: product_property
- id: '538'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '12'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '187'
type: variant
primary_variant:
data:
id: '71'
type: variant
- id: '107'
type: product
attributes:
name: Oversize Sweatshirt
description: Corporis amet dolore aspernatur molestiae. Animi amet quia sit quam unde sed. Similique natus ab veritatis reprehenderit vel vero maiores voluptatibus. Ut cum tempore velit in consectetur. Temporibus itaque quam architecto excepturi rerum.
available_on: '2021-10-02T11:02:30.806Z'
slug: oversize-sweatshirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.994Z'
sku: Sweatshirts_oversizesweatshirt_93.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '93.99'
display_price: $93.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '223'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '711'
type: product_property
- id: '712'
type: product_property
- id: '713'
type: product_property
- id: '714'
type: product_property
- id: '715'
type: product_property
- id: '716'
type: product_property
- id: '717'
type: product_property
- id: '718'
type: product_property
taxons:
data:
- id: '19'
type: taxon
- id: '16'
type: taxon
- id: '4'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '223'
type: variant
primary_variant:
data:
id: '107'
type: variant
- id: '111'
type: product
attributes:
name: Short Pants
description: Voluptatem est rem rerum autem quaerat eligendi quas non. Expedita quod veritatis dolorum excepturi ad error accusantium. Distinctio similique expedita nemo ducimus. Cumque natus consequatur cum repellat dicta esse enim. Expedita ducimus sit tenetur at unde eius porro.
available_on: '2021-10-02T11:02:31.294Z'
slug: short-pants
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:15.110Z'
sku: Pants_shortpants_15.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '15.99'
display_price: $15.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '227'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '743'
type: product_property
- id: '744'
type: product_property
- id: '745'
type: product_property
- id: '746'
type: product_property
- id: '747'
type: product_property
- id: '748'
type: product_property
- id: '749'
type: product_property
- id: '750'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '17'
type: taxon
- id: '4'
type: taxon
- id: '26'
type: taxon
images:
data: []
default_variant:
data:
id: '227'
type: variant
primary_variant:
data:
id: '111'
type: variant
- id: '15'
type: product
attributes:
name: T Shirt With Holes
description: Voluptatem ut facere eveniet corrupti impedit expedita quas voluptate. Officia exercitationem inventore in deleniti aliquam voluptatem fugit quibusdam. Ex quod minus nisi adipisci provident et. Eos excepturi quis eius natus porro numquam assumenda. Rem error molestiae quisquam doloremque ipsam dolor maiores.
available_on: '2021-10-02T11:02:18.944Z'
slug: t-shirt-with-holes
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.115Z'
sku: T-shirts_t-shirtwithholes_27.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '27.99'
display_price: $27.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '131'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '25'
type: product_property
- id: '26'
type: product_property
- id: '27'
type: product_property
- id: '28'
type: product_property
- id: '29'
type: product_property
- id: '30'
type: product_property
- id: '31'
type: product_property
- id: '32'
type: product_property
- id: '203'
type: product_property
- id: '204'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '6'
type: taxon
- id: '2'
type: taxon
images:
data: []
default_variant:
data:
id: '131'
type: variant
primary_variant:
data:
id: '15'
type: variant
- id: '64'
type: product
attributes:
name: Blouse With Wide Flounced Sleeve
description: Corrupti rem ab nihil in laborum corporis. Laborum itaque illo perferendis cum alias possimus. Minima perferendis vitae quae culpa debitis. Fugit debitis iure qui possimus praesentium incidunt dignissimos omnis. Harum omnis quidem magni alias nam odio.
available_on: '2021-10-02T11:02:25.227Z'
slug: blouse-with-wide-flounced-sleeve
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.608Z'
sku: ShirtsandBlouses_blousewithwideflouncedsleeve_42.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '42.99'
display_price: $42.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '180'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '809'
type: product_property
- id: '810'
type: product_property
- id: '811'
type: product_property
- id: '812'
type: product_property
- id: '813'
type: product_property
- id: '814'
type: product_property
- id: '815'
type: product_property
- id: '816'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '20'
type: taxon
- id: '11'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '180'
type: variant
primary_variant:
data:
id: '64'
type: variant
- id: '95'
type: product
attributes:
name: Denim Hooded Jacket
description: Harum expedita quibusdam consequatur soluta cum dolore id ratione. Quam ex nemo asperiores aspernatur doloremque odit. Ullam sunt labore sit nostrum.
available_on: '2021-10-02T11:02:29.164Z'
slug: denim-hooded-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.650Z'
sku: JacketsandCoats_denimhoodedjacket_15.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '15.99'
display_price: $15.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '211'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '631'
type: product_property
- id: '632'
type: product_property
- id: '633'
type: product_property
- id: '634'
type: product_property
- id: '635'
type: product_property
- id: '636'
type: product_property
- id: '637'
type: product_property
- id: '638'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '14'
type: taxon
- id: '24'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '211'
type: variant
primary_variant:
data:
id: '95'
type: variant
- id: '5'
type: product
attributes:
name: Short Sleeve Shirt
description: Facilis necessitatibus tempora nesciunt porro distinctio. Nihil culpa hic necessitatibus perspiciatis. Exercitationem consequatur magnam harum vitae ipsa amet delectus. Libero nobis unde illo mollitia.
available_on: '2021-10-02T11:02:17.712Z'
slug: short-sleeve-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.840Z'
sku: Shirts_shortsleeveshirt_16.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '16.99'
display_price: $16.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '121'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '161'
type: product_property
- id: '162'
type: product_property
- id: '163'
type: product_property
- id: '164'
type: product_property
- id: '165'
type: product_property
- id: '166'
type: product_property
- id: '167'
type: product_property
- id: '168'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '5'
type: taxon
- id: '2'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '121'
type: variant
primary_variant:
data:
id: '5'
type: variant
- id: '30'
type: product
attributes:
name: Anorak With Hood
description: Quidem qui ad nulla facere. Maxime vitae at doloribus non tenetur ut ipsam. Ad maxime architecto molestias quidem maiores iusto optio.
available_on: '2021-10-02T11:02:20.789Z'
slug: anorak-with-hood
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.573Z'
sku: JacketsandCoats_anorakwithhood_43.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '43.99'
display_price: $43.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '146'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '259'
type: product_property
- id: '260'
type: product_property
- id: '261'
type: product_property
- id: '262'
type: product_property
- id: '263'
type: product_property
- id: '264'
type: product_property
- id: '265'
type: product_property
- id: '266'
type: product_property
taxons:
data:
- id: '2'
type: taxon
- id: '8'
type: taxon
images:
data: []
default_variant:
data:
id: '146'
type: variant
primary_variant:
data:
id: '30'
type: variant
- id: '7'
type: product
attributes:
name: Regular Shirt
description: Incidunt quis assumenda debitis aliquam repellendus eveniet officiis recusandae. Debitis facere rerum natus cumque aliquam in. Ducimus voluptate cupiditate fugit quisquam.
available_on: '2021-10-02T11:02:17.952Z'
slug: regular-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.901Z'
sku: Shirts_regularshirt_74.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '74.99'
display_price: $74.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '123'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '177'
type: product_property
- id: '178'
type: product_property
- id: '179'
type: product_property
- id: '180'
type: product_property
- id: '181'
type: product_property
- id: '182'
type: product_property
- id: '183'
type: product_property
- id: '184'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '5'
type: taxon
- id: '2'
type: taxon
- id: '26'
type: taxon
- id: '21'
type: taxon
images:
data: []
default_variant:
data:
id: '123'
type: variant
primary_variant:
data:
id: '7'
type: variant
- id: '60'
type: product
attributes:
name: V Neck Wide Shirt
description: Similique ratione architecto quaerat dolores quas. Labore deleniti quidem temporibus eaque iste odio. Reiciendis laboriosam neque soluta debitis quae recusandae.
available_on: '2021-10-02T11:02:24.745Z'
slug: v-neck-wide-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.521Z'
sku: ShirtsandBlouses_v-neckwideshirt_50.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '50.99'
display_price: $50.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '176'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '467'
type: product_property
- id: '468'
type: product_property
- id: '469'
type: product_property
- id: '470'
type: product_property
- id: '471'
type: product_property
- id: '472'
type: product_property
- id: '473'
type: product_property
- id: '474'
type: product_property
taxons:
data:
- id: '11'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '176'
type: variant
primary_variant:
data:
id: '60'
type: variant
- id: '110'
type: product
attributes:
name: Shined Pants
description: Suscipit accusamus placeat cum incidunt. Distinctio ducimus occaecati ut mollitia. Laboriosam aliquam quos natus accusantium eligendi aliquid. Nemo officiis dignissimos veniam reiciendis dolores. Ad itaque aspernatur laborum ullam.
available_on: '2021-10-02T11:02:31.172Z'
slug: shined-pants
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:15.075Z'
sku: Pants_shinedpants_44.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '44.99'
display_price: $44.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '226'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '735'
type: product_property
- id: '736'
type: product_property
- id: '737'
type: product_property
- id: '738'
type: product_property
- id: '739'
type: product_property
- id: '740'
type: product_property
- id: '741'
type: product_property
- id: '742'
type: product_property
taxons:
data:
- id: '17'
type: taxon
- id: '19'
type: taxon
- id: '4'
type: taxon
- id: '18'
type: taxon
- id: '21'
type: taxon
images:
data: []
default_variant:
data:
id: '226'
type: variant
primary_variant:
data:
id: '110'
type: variant
meta:
count: 25
total_count: 116
total_pages: 5
filters:
option_types:
- id: 1
name: color
presentation: Color
option_values:
- id: 4
name: black
presentation: '#000000'
position: 4
- id: 11
name: mint
presentation: '#AAF0D1'
position: 11
- id: 6
name: green
presentation: '#228C22'
position: 6
- id: 2
name: purple
presentation: '#800080'
position: 2
- id: 10
name: beige
presentation: '#E1C699'
position: 10
- id: 17
name: pink
presentation: '#FFA6C9'
position: 17
- id: 7
name: grey
presentation: '#808080'
position: 7
- id: 8
name: orange
presentation: '#FF8800'
position: 8
- id: 15
name: yellow
presentation: '#FFFF00'
position: 15
- id: 1
name: white
presentation: '#FFFFFF'
position: 1
- id: 13
name: dark_blue
presentation: '#00008b'
position: 13
- id: 19
name: ecru
presentation: '#F4F2D6'
position: 19
- id: 3
name: red
presentation: '#FF0000'
position: 3
- id: 12
name: blue
presentation: '#0000FF'
position: 12
- id: 16
name: light_blue
presentation: '#add8e6'
position: 16
- id: 9
name: burgundy
presentation: '#A8003B'
position: 9
- id: 14
name: khaki
presentation: '#BDB76B'
position: 14
- id: 5
name: brown
presentation: '#8B4513'
position: 5
- id: 2
name: length
presentation: Length
option_values:
- id: 20
name: mini
presentation: Mini
position: 1
- id: 3
name: size
presentation: Size
option_values:
- id: 23
name: xs
presentation: XS
position: 1
product_properties:
- id: 1
name: manufacturer
presentation: Manufacturer
values:
- value: Conditioned
filter_param: conditioned
- value: Jerseys
filter_param: jerseys
- value: Resiliance
filter_param: resiliance
- value: Wannabe
filter_param: wannabe
- value: Wilson
filter_param: wilson
- id: 2
name: brand
presentation: Brand
values:
- value: Alpha
filter_param: alpha
- value: Beta
filter_param: beta
- value: Delta
filter_param: delta
- value: Epsilon
filter_param: epsilon
- value: Gamma
filter_param: gamma
- value: Theta
filter_param: theta
- value: Zeta
filter_param: zeta
links:
self: 'http://localhost:3000/api/v2/storefront/products'
next: 'http://localhost:3000/api/v2/storefront/products?page=2'
prev: 'http://localhost:3000/api/v2/storefront/products?page=1'
last: 'http://localhost:3000/api/v2/storefront/products?page=5'
first: 'http://localhost:3000/api/v2/storefront/products?page=1'
Store:
description: 200 Success - Returns the `store` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Store'
included:
type: array
items:
$ref: '#/components/schemas/StoreIncludes'
required:
- data
examples:
Store without includes:
value:
data:
id: '3'
type: store
attributes:
name: Mystore
url: spree-demo.com
meta_description: Luxury clothing store for men and women.
meta_keywords: luxury clothing men women
seo_title: ''
default_currency: USD
default: true
supported_currencies: 'EUR,GBP,USD'
facebook: 'https://www.facebook.com/mystorename'
twitter: 'https://twitter.com/mystorename'
instagram: 'https://instagram.com/mystorename'
default_locale: en
customer_support_email: support@mystore.com
description: Mystore has been selling luxury clothing for more than 20 years and has 15 stores currently.
address: '813 Howard Street, Oswego NY 13126, USA'
contact_phone: '+123456789'
supported_locales: en
favicon_path: /assets/favicon.ico
relationships:
menus:
data:
- id: '10'
type: menu
- id: '11'
type: menu
cms_pages:
data:
- id: '5'
type: cms_page
default_country:
data:
id: '2'
type: country
Store with Includes:
value:
data:
id: '3'
type: store
attributes:
name: Mystore
url: spree-demo.com
meta_description: Luxury clothing store for men and women.
meta_keywords: luxury clothing men women
seo_title: ''
default_currency: USD
default: true
supported_currencies: 'EUR,GBP,USD'
facebook: 'https://www.facebook.com/mystorename'
twitter: 'https://twitter.com/mystorename'
instagram: 'https://instagram.com/mystorename'
default_locale: en
customer_support_email: support@mystore.com
description: Mystore has been selling luxury clothing for more than 20 years and has 15 stores currently.
address: '813 Howard Street, Oswego NY 13126, USA'
contact_phone: '+123456789'
supported_locales: en
favicon_path: /assets/favicon.ico
relationships:
menus:
data:
- id: '10'
type: menu
- id: '11'
type: menu
cms_pages:
data:
- id: '5'
type: cms_page
default_country:
data:
id: '2'
type: country
included:
- id: '2'
type: country
attributes:
iso: US
iso3: USA
iso_name: UNITED STATES
name: United States
states_required: true
zipcode_required: true
default: true
relationships:
checkout_zone_applicable_states:
data: []
- id: '10'
type: cms_page
attributes:
title: Returns Policy
content: null
locale: en
meta_description: ''
meta_title: ''
slug: returns-policy
type: 'Spree::Cms::Pages::StandardPage'
relationships:
cms_sections:
data: []
- id: '12'
type: menu
attributes:
name: Company
location: header
locale: en
relationships:
menu_items:
data:
- id: '1'
type: menu_item
- id: '2'
type: menu_item
Taxon:
description: 200 Success - Returns the `taxon` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Taxon'
included:
type: array
items:
$ref: '#/components/schemas/TaxonIncludes'
required:
- data
examples:
Taxon:
value:
data:
id: '22'
type: taxon
attributes:
name: Summer Sale
pretty_name: Categories -> Summer Sale
permalink: categories/summer-sale
seo_title: Summer Sale
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 42
right: 43
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.118Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
products:
data:
- id: '76'
type: product
- id: '92'
type: product
- id: '112'
type: product
- id: '15'
type: product
- id: '86'
type: product
- id: '52'
type: product
- id: '78'
type: product
- id: '36'
type: product
- id: '93'
type: product
- id: '73'
type: product
- id: '83'
type: product
- id: '7'
type: product
- id: '95'
type: product
- id: '8'
type: product
- id: '59'
type: product
- id: '28'
type: product
- id: '41'
type: product
- id: '66'
type: product
- id: '10'
type: product
- id: '12'
type: product
- id: '21'
type: product
- id: '111'
type: product
- id: '48'
type: product
- id: '46'
type: product
- id: '5'
type: product
- id: '71'
type: product
- id: '103'
type: product
- id: '20'
type: product
- id: '62'
type: product
- id: '64'
type: product
image:
data: null
Taxon Including Products:
value:
data:
id: '22'
type: taxon
attributes:
name: Summer Sale
pretty_name: Categories -> Summer Sale
permalink: categories/summer-sale
seo_title: Summer Sale
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 42
right: 43
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.118Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
products:
data:
- id: '76'
type: product
- id: '92'
type: product
- id: '112'
type: product
- id: '15'
type: product
- id: '86'
type: product
- id: '52'
type: product
- id: '78'
type: product
- id: '36'
type: product
- id: '93'
type: product
- id: '73'
type: product
- id: '83'
type: product
- id: '7'
type: product
- id: '95'
type: product
- id: '8'
type: product
- id: '59'
type: product
- id: '28'
type: product
- id: '41'
type: product
- id: '66'
type: product
- id: '10'
type: product
- id: '12'
type: product
- id: '21'
type: product
- id: '111'
type: product
- id: '48'
type: product
- id: '46'
type: product
- id: '5'
type: product
- id: '71'
type: product
- id: '103'
type: product
- id: '20'
type: product
- id: '62'
type: product
- id: '64'
type: product
image:
data: null
included:
- id: '76'
type: product
attributes:
name: Crop Top With Tie
description: Expedita unde totam dolorum delectus maiores nostrum. Ratione aut hic nisi similique tempore ipsum eveniet voluptatibus. Accusantium est perspiciatis distinctio vel ipsa. Magni eius fuga non harum esse asperiores error. Vitae sunt maiores ab magnam fuga facere temporibus quisquam.
available_on: '2021-10-02T11:02:26.807Z'
slug: crop-top-with-tie
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.094Z'
sku: TopsandT-shirts_croptopwithtie_61.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '61.99'
display_price: $61.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '192'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '65'
type: product_property
- id: '66'
type: product_property
- id: '67'
type: product_property
- id: '68'
type: product_property
- id: '69'
type: product_property
- id: '70'
type: product_property
- id: '71'
type: product_property
- id: '72'
type: product_property
- id: '571'
type: product_property
- id: '572'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '20'
type: taxon
- id: '13'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '192'
type: variant
primary_variant:
data:
id: '76'
type: variant
- id: '92'
type: product
attributes:
name: Double Breasted Jacket
description: Suscipit deserunt minus non ea occaecati rerum optio. Eveniet consequuntur doloribus nam perspiciatis. Voluptatibus nostrum nisi expedita fugit accusamus aliquid quasi ratione. Molestiae dolor voluptatibus dolorem impedit explicabo. Doloribus natus dolore id reprehenderit adipisci accusamus amet.
available_on: '2021-10-02T11:02:28.794Z'
slug: double-breasted-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.547Z'
sku: JacketsandCoats_double-breastedjacket_86.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '86.99'
display_price: $86.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '208'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '889'
type: product_property
- id: '890'
type: product_property
- id: '891'
type: product_property
- id: '892'
type: product_property
- id: '893'
type: product_property
- id: '894'
type: product_property
- id: '895'
type: product_property
- id: '896'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '20'
type: taxon
- id: '14'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '208'
type: variant
primary_variant:
data:
id: '92'
type: variant
- id: '112'
type: product
attributes:
name: Printed Pants With Holes
description: Sed quia quos voluptate occaecati architecto quidem. Voluptatem ducimus sit explicabo consequuntur hic consectetur at aperiam. Vero quo eius voluptatum animi. Temporibus architecto aliquam vero ut. Quasi velit illo harum delectus dicta.
available_on: '2021-10-02T11:02:31.417Z'
slug: printed-pants-with-holes
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.438Z'
sku: Pants_printedpantswithholes_91.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '91.99'
display_price: $91.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '228'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '751'
type: product_property
- id: '752'
type: product_property
- id: '753'
type: product_property
- id: '754'
type: product_property
- id: '755'
type: product_property
- id: '756'
type: product_property
- id: '757'
type: product_property
- id: '758'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '17'
type: taxon
- id: '4'
type: taxon
- id: '26'
type: taxon
images:
data: []
default_variant:
data:
id: '228'
type: variant
primary_variant:
data:
id: '112'
type: variant
- id: '15'
type: product
attributes:
name: T Shirt With Holes
description: Voluptatem ut facere eveniet corrupti impedit expedita quas voluptate. Officia exercitationem inventore in deleniti aliquam voluptatem fugit quibusdam. Ex quod minus nisi adipisci provident et. Eos excepturi quis eius natus porro numquam assumenda. Rem error molestiae quisquam doloremque ipsam dolor maiores.
available_on: '2021-10-02T11:02:18.944Z'
slug: t-shirt-with-holes
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.115Z'
sku: T-shirts_t-shirtwithholes_27.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '27.99'
display_price: $27.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '131'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '25'
type: product_property
- id: '26'
type: product_property
- id: '27'
type: product_property
- id: '28'
type: product_property
- id: '29'
type: product_property
- id: '30'
type: product_property
- id: '31'
type: product_property
- id: '32'
type: product_property
- id: '203'
type: product_property
- id: '204'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '6'
type: taxon
- id: '2'
type: taxon
images:
data: []
default_variant:
data:
id: '131'
type: variant
primary_variant:
data:
id: '15'
type: variant
- id: '86'
type: product
attributes:
name: Long Wool Blend Coat With Belt
description: Consequatur atque porro quod iure suscipit facere. Itaque maiores velit dolorum tempora quam blanditiis modi ex. Cum at harum aperiam occaecati consequuntur ea. Expedita consequatur fugiat tempora perferendis praesentium ut. Tempore at natus voluptates quisquam quae praesentium explicabo.
available_on: '2021-10-02T11:02:28.040Z'
slug: long-wool-blend-coat-with-belt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.384Z'
sku: JacketsandCoats_longwool-blendcoatwithbelt_11.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '11.99'
display_price: $11.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '202'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '905'
type: product_property
- id: '906'
type: product_property
- id: '907'
type: product_property
- id: '908'
type: product_property
- id: '909'
type: product_property
- id: '910'
type: product_property
- id: '911'
type: product_property
- id: '912'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '20'
type: taxon
- id: '14'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '202'
type: variant
primary_variant:
data:
id: '86'
type: variant
- id: '52'
type: product
attributes:
name: Printed Dress
description: Inventore perferendis assumenda quia libero dolore error quam occaecati. Eaque distinctio magnam ut aut voluptas facere. Perferendis qui adipisci dolor praesentium harum. Saepe unde voluptates nemo occaecati voluptas assumenda tempore. Adipisci voluptates at corporis ab sed sequi.
available_on: '2021-10-02T11:02:23.730Z'
slug: printed-dress
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.274Z'
sku: Dresses_printeddress_86.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '86.99'
display_price: $86.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '168'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '2'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '411'
type: product_property
- id: '412'
type: product_property
- id: '413'
type: product_property
- id: '414'
type: product_property
- id: '415'
type: product_property
- id: '416'
type: product_property
- id: '417'
type: product_property
- id: '418'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '10'
type: taxon
- id: '24'
type: taxon
- id: '21'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '168'
type: variant
primary_variant:
data:
id: '52'
type: variant
- id: '78'
type: product
attributes:
name: Scrappy Top
description: Deserunt qui non officiis nostrum. Nam itaque a suscipit aspernatur animi illo beatae laboriosam. Dolores dignissimos soluta quidem minima expedita.
available_on: '2021-10-02T11:02:27.051Z'
slug: scrappy-top
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.156Z'
sku: TopsandT-shirts_scrappytop_31.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '31.99'
display_price: $31.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '194'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '81'
type: product_property
- id: '82'
type: product_property
- id: '83'
type: product_property
- id: '84'
type: product_property
- id: '85'
type: product_property
- id: '86'
type: product_property
- id: '87'
type: product_property
- id: '88'
type: product_property
- id: '573'
type: product_property
- id: '574'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '13'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '194'
type: variant
primary_variant:
data:
id: '78'
type: variant
- id: '36'
type: product
attributes:
name: Flared Midi Skirt
description: Totam vero modi ex in architecto quidem. Quod mollitia accusantium nihil aliquid esse dolore. Atque velit ad eius tenetur molestias. Mollitia soluta impedit repellat quos possimus cumque.
available_on: '2021-10-02T11:02:21.523Z'
slug: flared-midi-skirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.751Z'
sku: Skirts_flaredmidiskirt_93.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '93.99'
display_price: $93.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '152'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '2'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '299'
type: product_property
- id: '300'
type: product_property
- id: '301'
type: product_property
- id: '302'
type: product_property
- id: '303'
type: product_property
- id: '304'
type: product_property
- id: '305'
type: product_property
- id: '306'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '9'
type: taxon
- id: '21'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '152'
type: variant
primary_variant:
data:
id: '36'
type: variant
- id: '93'
type: product
attributes:
name: Leather Biker Jacket
description: At tempora ullam saepe earum voluptates. Tempora nisi sunt libero optio provident praesentium. Quas odit quaerat ad numquam. Consectetur consequuntur magnam delectus facere illo unde.
available_on: '2021-10-02T11:02:28.913Z'
slug: leather-biker-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.585Z'
sku: JacketsandCoats_leatherbikerjacket_52.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '52.99'
display_price: $52.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '209'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '615'
type: product_property
- id: '616'
type: product_property
- id: '617'
type: product_property
- id: '618'
type: product_property
- id: '619'
type: product_property
- id: '620'
type: product_property
- id: '621'
type: product_property
- id: '622'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '18'
type: taxon
- id: '14'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '209'
type: variant
primary_variant:
data:
id: '93'
type: variant
- id: '73'
type: product
attributes:
name: Knitted High Neck Sweater
description: Eveniet adipisci facere nihil repellat accusamus nostrum. Laboriosam eius magnam asperiores facere perspiciatis quo. Eos fugit non mollitia sed incidunt magni dolorem error. Occaecati unde ea sit veritatis sed officia. Aperiam sequi reiciendis sint neque praesentium.
available_on: '2021-10-02T11:02:26.434Z'
slug: knitted-high-neck-sweater
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.879Z'
sku: Sweaters_knittedhighnecksweater_23.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '23.99'
display_price: $23.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '189'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '547'
type: product_property
- id: '548'
type: product_property
- id: '549'
type: product_property
- id: '550'
type: product_property
- id: '551'
type: product_property
- id: '552'
type: product_property
- id: '553'
type: product_property
- id: '554'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '12'
type: taxon
- id: '18'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '189'
type: variant
primary_variant:
data:
id: '73'
type: variant
- id: '83'
type: product
attributes:
name: Sleeveless Loose Top
description: Minima expedita porro tempora sit odio. Nulla qui laboriosam dignissimos sit earum numquam omnis. Harum repellendus ex porro voluptatum. Corporis impedit culpa eum maxime voluptates.
available_on: '2021-10-02T11:02:27.671Z'
slug: sleeveless-loose-top
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.304Z'
sku: TopsandT-shirts_sleevelessloosetop_26.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '26.99'
display_price: $26.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '199'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '121'
type: product_property
- id: '122'
type: product_property
- id: '123'
type: product_property
- id: '124'
type: product_property
- id: '125'
type: product_property
- id: '126'
type: product_property
- id: '127'
type: product_property
- id: '128'
type: product_property
- id: '581'
type: product_property
- id: '582'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '18'
type: taxon
- id: '13'
type: taxon
- id: '24'
type: taxon
- id: '26'
type: taxon
- id: '21'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '199'
type: variant
primary_variant:
data:
id: '83'
type: variant
- id: '7'
type: product
attributes:
name: Regular Shirt
description: Incidunt quis assumenda debitis aliquam repellendus eveniet officiis recusandae. Debitis facere rerum natus cumque aliquam in. Ducimus voluptate cupiditate fugit quisquam.
available_on: '2021-10-02T11:02:17.952Z'
slug: regular-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.901Z'
sku: Shirts_regularshirt_74.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '74.99'
display_price: $74.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '123'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '177'
type: product_property
- id: '178'
type: product_property
- id: '179'
type: product_property
- id: '180'
type: product_property
- id: '181'
type: product_property
- id: '182'
type: product_property
- id: '183'
type: product_property
- id: '184'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '5'
type: taxon
- id: '2'
type: taxon
- id: '26'
type: taxon
- id: '21'
type: taxon
images:
data: []
default_variant:
data:
id: '123'
type: variant
primary_variant:
data:
id: '7'
type: variant
- id: '95'
type: product
attributes:
name: Denim Hooded Jacket
description: Harum expedita quibusdam consequatur soluta cum dolore id ratione. Quam ex nemo asperiores aspernatur doloremque odit. Ullam sunt labore sit nostrum.
available_on: '2021-10-02T11:02:29.164Z'
slug: denim-hooded-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.650Z'
sku: JacketsandCoats_denimhoodedjacket_15.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '15.99'
display_price: $15.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '211'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '631'
type: product_property
- id: '632'
type: product_property
- id: '633'
type: product_property
- id: '634'
type: product_property
- id: '635'
type: product_property
- id: '636'
type: product_property
- id: '637'
type: product_property
- id: '638'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '14'
type: taxon
- id: '24'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '211'
type: variant
primary_variant:
data:
id: '95'
type: variant
- id: '8'
type: product
attributes:
name: Checked Slim Fit Shirt
description: Doloremque aspernatur aperiam doloribus laborum ullam. Cupiditate accusantium eaque sit pariatur earum a. Corrupti architecto assumenda sunt veniam.
available_on: '2021-10-02T11:02:18.079Z'
slug: checked-slim-fit-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.931Z'
sku: Shirts_checkedslimfitshirt_37.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '37.99'
display_price: $37.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '124'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '833'
type: product_property
- id: '834'
type: product_property
- id: '835'
type: product_property
- id: '836'
type: product_property
- id: '837'
type: product_property
- id: '838'
type: product_property
- id: '839'
type: product_property
- id: '840'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '5'
type: taxon
- id: '20'
type: taxon
- id: '18'
type: taxon
- id: '2'
type: taxon
- id: '21'
type: taxon
images:
data: []
default_variant:
data:
id: '124'
type: variant
primary_variant:
data:
id: '8'
type: variant
- id: '59'
type: product
attributes:
name: Striped Shirt
description: Debitis reprehenderit blanditiis expedita quia suscipit. Quod praesentium velit maxime placeat quam illo consequatur. Qui aut autem vel excepturi magni hic ut maxime.
available_on: '2021-10-02T11:02:24.616Z'
slug: striped-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.488Z'
sku: ShirtsandBlouses_stripedshirt_40.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '40.99'
display_price: $40.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '175'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '459'
type: product_property
- id: '460'
type: product_property
- id: '461'
type: product_property
- id: '462'
type: product_property
- id: '463'
type: product_property
- id: '464'
type: product_property
- id: '465'
type: product_property
- id: '466'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '11'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '175'
type: variant
primary_variant:
data:
id: '59'
type: variant
- id: '28'
type: product
attributes:
name: Suede Biker Jacket
description: Explicabo iste maiores commodi itaque mollitia delectus officia dolorum. Aliquam qui rem quae facilis architecto libero officia. Consequatur debitis dolore provident asperiores.
available_on: '2021-10-02T11:02:20.541Z'
slug: suede-biker-jacket
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.509Z'
sku: JacketsandCoats_suedebikerjacket_27.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '27.99'
display_price: $27.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '144'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '801'
type: product_property
- id: '802'
type: product_property
- id: '803'
type: product_property
- id: '804'
type: product_property
- id: '805'
type: product_property
- id: '806'
type: product_property
- id: '807'
type: product_property
- id: '808'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '20'
type: taxon
- id: '2'
type: taxon
- id: '8'
type: taxon
- id: '26'
type: taxon
images:
data: []
default_variant:
data:
id: '144'
type: variant
primary_variant:
data:
id: '28'
type: variant
- id: '41'
type: product
attributes:
name: Flared Skirt
description: Sunt modi veniam eum dolore fugit. Et reiciendis dolores impedit tempora laudantium illo ipsa. Cum minus ea nobis illum odit omnis eveniet. Corrupti est qui delectus autem voluptas dicta ad dolore.
available_on: '2021-10-02T11:02:22.172Z'
slug: flared-skirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.951Z'
sku: Skirts_flaredskirt_71.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '71.99'
display_price: $71.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '157'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '2'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '331'
type: product_property
- id: '332'
type: product_property
- id: '333'
type: product_property
- id: '334'
type: product_property
- id: '335'
type: product_property
- id: '336'
type: product_property
- id: '337'
type: product_property
- id: '338'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '9'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '157'
type: variant
primary_variant:
data:
id: '41'
type: variant
- id: '66'
type: product
attributes:
name: Floral Shirt
description: Veritatis alias dolores accusamus quaerat ipsa. Ab quibusdam provident necessitatibus deserunt rerum. Eaque laborum ducimus labore earum aspernatur sit nisi. Soluta amet earum provident blanditiis ut quibusdam facilis labore. Nihil commodi eaque assumenda quibusdam debitis autem laborum.
available_on: '2021-10-02T11:02:25.553Z'
slug: floral-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.668Z'
sku: ShirtsandBlouses_floralshirt_41.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '41.99'
display_price: $41.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '182'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '499'
type: product_property
- id: '500'
type: product_property
- id: '501'
type: product_property
- id: '502'
type: product_property
- id: '503'
type: product_property
- id: '504'
type: product_property
- id: '505'
type: product_property
- id: '506'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '11'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '182'
type: variant
primary_variant:
data:
id: '66'
type: variant
- id: '10'
type: product
attributes:
name: Linen Shirt
description: Iure ea aliquam deleniti blanditiis magnam aspernatur. Voluptas aut harum quidem commodi. Ratione perferendis autem magni odio. Inventore sed corporis at explicabo incidunt quam.
available_on: '2021-10-02T11:02:18.324Z'
slug: linen-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.991Z'
sku: Shirts_linenshirt_41.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '41.99'
display_price: $41.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '126'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '193'
type: product_property
- id: '194'
type: product_property
- id: '195'
type: product_property
- id: '196'
type: product_property
- id: '197'
type: product_property
- id: '198'
type: product_property
- id: '199'
type: product_property
- id: '200'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '5'
type: taxon
- id: '18'
type: taxon
- id: '2'
type: taxon
images:
data: []
default_variant:
data:
id: '126'
type: variant
primary_variant:
data:
id: '10'
type: variant
- id: '12'
type: product
attributes:
name: Polo T Shirt
description: Veniam modi inventore recusandae eos temporibus quam. Doloremque minus nisi ab nihil enim inventore. Vero vitae a sunt provident recusandae iste laudantium. Reprehenderit necessitatibus minus et similique consequatur nam molestiae id.
available_on: '2021-10-02T11:02:18.574Z'
slug: polo-t-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.024Z'
sku: T-shirts_polot-shirt_82.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '82.99'
display_price: $82.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '128'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '1'
type: product_property
- id: '2'
type: product_property
- id: '3'
type: product_property
- id: '4'
type: product_property
- id: '5'
type: product_property
- id: '6'
type: product_property
- id: '7'
type: product_property
- id: '8'
type: product_property
- id: '961'
type: product_property
- id: '962'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '6'
type: taxon
- id: '18'
type: taxon
- id: '2'
type: taxon
- id: '21'
type: taxon
images:
data: []
default_variant:
data:
id: '128'
type: variant
primary_variant:
data:
id: '12'
type: variant
- id: '21'
type: product
attributes:
name: Stripped Jumper
description: Placeat nemo vel molestiae sequi totam optio. Eaque distinctio incidunt blanditiis saepe voluptate. Ullam officia est nobis dolor. Facilis quam voluptas provident vero dolores. Nam consequuntur velit dolores recusandae excepturi veniam.
available_on: '2021-10-02T11:02:19.687Z'
slug: stripped-jumper
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.299Z'
sku: Sweaters_strippedjumper_84.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '84.99'
display_price: $84.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '137'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '211'
type: product_property
- id: '212'
type: product_property
- id: '213'
type: product_property
- id: '214'
type: product_property
- id: '215'
type: product_property
- id: '216'
type: product_property
- id: '217'
type: product_property
- id: '218'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '2'
type: taxon
- id: '7'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '137'
type: variant
primary_variant:
data:
id: '21'
type: variant
- id: '111'
type: product
attributes:
name: Short Pants
description: Voluptatem est rem rerum autem quaerat eligendi quas non. Expedita quod veritatis dolorum excepturi ad error accusantium. Distinctio similique expedita nemo ducimus. Cumque natus consequatur cum repellat dicta esse enim. Expedita ducimus sit tenetur at unde eius porro.
available_on: '2021-10-02T11:02:31.294Z'
slug: short-pants
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:15.110Z'
sku: Pants_shortpants_15.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '15.99'
display_price: $15.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '227'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '743'
type: product_property
- id: '744'
type: product_property
- id: '745'
type: product_property
- id: '746'
type: product_property
- id: '747'
type: product_property
- id: '748'
type: product_property
- id: '749'
type: product_property
- id: '750'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '17'
type: taxon
- id: '4'
type: taxon
- id: '26'
type: taxon
images:
data: []
default_variant:
data:
id: '227'
type: variant
primary_variant:
data:
id: '111'
type: variant
- id: '48'
type: product
attributes:
name: Flared Dress
description: Ut ullam aspernatur facere dicta explicabo sed. Molestiae nihil atque sed voluptatibus officiis. Aspernatur vitae nesciunt non doloremque. Officiis velit et magnam molestias repellat. Asperiores modi totam labore iure aperiam sequi.
available_on: '2021-10-02T11:02:23.076Z'
slug: flared-dress
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.159Z'
sku: Dresses_flareddress_21.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '21.99'
display_price: $21.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '164'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '2'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '387'
type: product_property
- id: '388'
type: product_property
- id: '389'
type: product_property
- id: '390'
type: product_property
- id: '391'
type: product_property
- id: '392'
type: product_property
- id: '393'
type: product_property
- id: '394'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '18'
type: taxon
- id: '10'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '164'
type: variant
primary_variant:
data:
id: '48'
type: variant
- id: '46'
type: product
attributes:
name: Floral Wrap Dress
description: Libero quas ipsam earum accusamus voluptas ducimus. Adipisci modi vitae iure libero illo aperiam. Consequatur officia aliquid esse officiis error eligendi in. Est iusto voluptas ea ad reiciendis ratione. Earum a nemo tempora porro.
available_on: '2021-10-02T11:02:22.819Z'
slug: floral-wrap-dress
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.100Z'
sku: Dresses_floralwrapdress_68.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '68.99'
display_price: $68.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '162'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '2'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '371'
type: product_property
- id: '372'
type: product_property
- id: '373'
type: product_property
- id: '374'
type: product_property
- id: '375'
type: product_property
- id: '376'
type: product_property
- id: '377'
type: product_property
- id: '378'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '10'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '162'
type: variant
primary_variant:
data:
id: '46'
type: variant
- id: '5'
type: product
attributes:
name: Short Sleeve Shirt
description: Facilis necessitatibus tempora nesciunt porro distinctio. Nihil culpa hic necessitatibus perspiciatis. Exercitationem consequatur magnam harum vitae ipsa amet delectus. Libero nobis unde illo mollitia.
available_on: '2021-10-02T11:02:17.712Z'
slug: short-sleeve-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.840Z'
sku: Shirts_shortsleeveshirt_16.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '16.99'
display_price: $16.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '121'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '161'
type: product_property
- id: '162'
type: product_property
- id: '163'
type: product_property
- id: '164'
type: product_property
- id: '165'
type: product_property
- id: '166'
type: product_property
- id: '167'
type: product_property
- id: '168'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '5'
type: taxon
- id: '2'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '121'
type: variant
primary_variant:
data:
id: '5'
type: variant
- id: '71'
type: product
attributes:
name: Oversized Knitted Sweater
description: Fuga nam provident beatae odio. Est vitae cum fuga corrupti delectus. Officiis harum nulla debitis ut.
available_on: '2021-10-02T11:02:26.186Z'
slug: oversized-knitted-sweater
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.821Z'
sku: Sweaters_oversizedknittedsweater_10.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '10.99'
display_price: $10.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '187'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '531'
type: product_property
- id: '532'
type: product_property
- id: '533'
type: product_property
- id: '534'
type: product_property
- id: '535'
type: product_property
- id: '536'
type: product_property
- id: '537'
type: product_property
- id: '538'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '12'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '187'
type: variant
primary_variant:
data:
id: '71'
type: variant
- id: '103'
type: product
attributes:
name: 'Sports Bra '
description: Commodi exercitationem adipisci beatae consectetur aliquid. Quas at nobis doloremque suscipit fugit. Recusandae et qui ab neque praesentium nulla eos. Totam a voluptas nostrum explicabo similique pariatur.
available_on: '2021-10-02T11:02:30.298Z'
slug: sports-bra
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:14.882Z'
sku: Tops_sportsbra_61.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '61.99'
display_price: $61.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '219'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '687'
type: product_property
- id: '688'
type: product_property
- id: '689'
type: product_property
- id: '690'
type: product_property
- id: '691'
type: product_property
- id: '692'
type: product_property
- id: '693'
type: product_property
- id: '694'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '4'
type: taxon
- id: '15'
type: taxon
images:
data: []
default_variant:
data:
id: '219'
type: variant
primary_variant:
data:
id: '103'
type: variant
- id: '20'
type: product
attributes:
name: High Neck Sweater
description: Consequatur alias doloribus tempore voluptatem voluptates reprehenderit. Sunt dolorum suscipit atque aliquam voluptatibus tempora. Adipisci harum maxime sequi temporibus laboriosam aut exercitationem cupiditate. Id distinctio fugit exercitationem necessitatibus consequuntur ipsa. Adipisci possimus autem numquam reprehenderit doloremque nobis sint nesciunt.
available_on: '2021-10-02T11:02:19.558Z'
slug: high-neck-sweater
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:12.263Z'
sku: Sweaters_highnecksweater_50.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '50.99'
display_price: $50.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '136'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '929'
type: product_property
- id: '930'
type: product_property
- id: '931'
type: product_property
- id: '932'
type: product_property
- id: '933'
type: product_property
- id: '934'
type: product_property
- id: '935'
type: product_property
- id: '936'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '20'
type: taxon
- id: '2'
type: taxon
- id: '7'
type: taxon
- id: '24'
type: taxon
images:
data: []
default_variant:
data:
id: '136'
type: variant
primary_variant:
data:
id: '20'
type: variant
- id: '62'
type: product
attributes:
name: Pleated Sleeve V Neck Shirt
description: Temporibus voluptates rerum nemo hic. Dolores molestias animi ratione eligendi. Est nulla ipsa dolore mollitia nisi culpa.
available_on: '2021-10-02T11:02:24.983Z'
slug: pleated-sleeve-v-neck-shirt
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:11.269Z'
sku: ShirtsandBlouses_pleatedsleevev-neckshirt_73.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '73.99'
display_price: $73.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '178'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '483'
type: product_property
- id: '484'
type: product_property
- id: '485'
type: product_property
- id: '486'
type: product_property
- id: '487'
type: product_property
- id: '488'
type: product_property
- id: '489'
type: product_property
- id: '490'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '11'
type: taxon
- id: '24'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '178'
type: variant
primary_variant:
data:
id: '62'
type: variant
- id: '64'
type: product
attributes:
name: Blouse With Wide Flounced Sleeve
description: Corrupti rem ab nihil in laborum corporis. Laborum itaque illo perferendis cum alias possimus. Minima perferendis vitae quae culpa debitis. Fugit debitis iure qui possimus praesentium incidunt dignissimos omnis. Harum omnis quidem magni alias nam odio.
available_on: '2021-10-02T11:02:25.227Z'
slug: blouse-with-wide-flounced-sleeve
meta_description: null
meta_keywords: null
updated_at: '2021-10-02T11:03:13.608Z'
sku: ShirtsandBlouses_blousewithwideflouncedsleeve_42.99
purchasable: true
in_stock: true
backorderable: false
available: true
currency: USD
price: '42.99'
display_price: $42.99
compare_at_price: null
display_compare_at_price: null
relationships:
variants:
data:
- id: '180'
type: variant
option_types:
data:
- id: '1'
type: option_type
- id: '3'
type: option_type
product_properties:
data:
- id: '809'
type: product_property
- id: '810'
type: product_property
- id: '811'
type: product_property
- id: '812'
type: product_property
- id: '813'
type: product_property
- id: '814'
type: product_property
- id: '815'
type: product_property
- id: '816'
type: product_property
taxons:
data:
- id: '22'
type: taxon
- id: '19'
type: taxon
- id: '20'
type: taxon
- id: '11'
type: taxon
- id: '26'
type: taxon
- id: '3'
type: taxon
images:
data: []
default_variant:
data:
id: '180'
type: variant
primary_variant:
data:
id: '64'
type: variant
TaxonList:
description: 200 Success - Returns an array of `taxon` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Taxon'
included:
type: array
items:
$ref: '#/components/schemas/TaxonIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
Standard Response:
value:
data:
- id: '22'
type: taxon
attributes:
name: Summer Sale
pretty_name: Categories -> Summer Sale
permalink: categories/summer-sale
seo_title: Summer Sale
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 42
right: 43
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.118Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '17'
type: taxon
attributes:
name: Pants
pretty_name: Categories -> Sportswear -> Pants
permalink: categories/sportswear/pants
seo_title: Pants
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 31
right: 32
position: 0
depth: 2
updated_at: '2021-10-02T11:03:15.146Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '4'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '19'
type: taxon
attributes:
name: Bestsellers
pretty_name: Categories -> Bestsellers
permalink: categories/bestsellers
seo_title: Bestsellers
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 36
right: 37
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.082Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '16'
type: taxon
attributes:
name: Sweatshirts
pretty_name: Categories -> Sportswear -> Sweatshirts
permalink: categories/sportswear/sweatshirts
seo_title: Sweatshirts
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 29
right: 30
position: 0
depth: 2
updated_at: '2021-10-02T11:03:15.054Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '4'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '6'
type: taxon
attributes:
name: T-shirts
pretty_name: Categories -> Men -> T-shirts
permalink: categories/men/t-shirts
seo_title: T-shirts
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 5
right: 6
position: 0
depth: 2
updated_at: '2021-10-02T11:03:12.242Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '2'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '4'
type: taxon
attributes:
name: Sportswear
pretty_name: Categories -> Sportswear
permalink: categories/sportswear
seo_title: Sportswear
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 26
right: 33
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.146Z'
is_root: false
is_child: true
is_leaf: false
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data:
- id: '15'
type: taxon
- id: '16'
type: taxon
- id: '17'
type: taxon
image:
data: null
- id: '9'
type: taxon
attributes:
name: Skirts
pretty_name: Categories -> Women -> Skirts
permalink: categories/women/skirts
seo_title: Skirts
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 13
right: 14
position: 0
depth: 2
updated_at: '2021-10-02T11:03:13.076Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '3'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '12'
type: taxon
attributes:
name: Sweaters
pretty_name: Categories -> Women -> Sweaters
permalink: categories/women/sweaters
seo_title: Sweaters
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 19
right: 20
position: 0
depth: 2
updated_at: '2021-10-02T11:03:14.071Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '3'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '15'
type: taxon
attributes:
name: Tops
pretty_name: Categories -> Sportswear -> Tops
permalink: categories/sportswear/tops
seo_title: Tops
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 27
right: 28
position: 0
depth: 2
updated_at: '2021-10-02T11:03:14.916Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '4'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '5'
type: taxon
attributes:
name: Shirts
pretty_name: Categories -> Men -> Shirts
permalink: categories/men/shirts
seo_title: Shirts
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 3
right: 4
position: 0
depth: 2
updated_at: '2021-10-02T11:03:11.998Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '2'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '20'
type: taxon
attributes:
name: Trending
pretty_name: Categories -> Trending
permalink: categories/trending
seo_title: Trending
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 38
right: 39
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.054Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '18'
type: taxon
attributes:
name: New
pretty_name: Categories -> New
permalink: categories/new
seo_title: New
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 34
right: 35
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.082Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '2'
type: taxon
attributes:
name: Men
pretty_name: Categories -> Men
permalink: categories/men
seo_title: Men
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 2
right: 11
position: 0
depth: 1
updated_at: '2021-10-02T11:03:12.728Z'
is_root: false
is_child: true
is_leaf: false
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data:
- id: '5'
type: taxon
- id: '6'
type: taxon
- id: '7'
type: taxon
- id: '8'
type: taxon
image:
data: null
- id: '8'
type: taxon
attributes:
name: Jackets and Coats
pretty_name: Categories -> Men -> Jackets and Coats
permalink: categories/men/jackets-and-coats
seo_title: Jackets and Coats
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 9
right: 10
position: 0
depth: 2
updated_at: '2021-10-02T11:03:12.728Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '2'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '7'
type: taxon
attributes:
name: Sweaters
pretty_name: Categories -> Men -> Sweaters
permalink: categories/men/sweaters
seo_title: Sweaters
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 7
right: 8
position: 0
depth: 2
updated_at: '2021-10-02T11:03:12.486Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '2'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '11'
type: taxon
attributes:
name: Shirts and Blouses
pretty_name: Categories -> Women -> Shirts and Blouses
permalink: categories/women/shirts-and-blouses
seo_title: Shirts and Blouses
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 17
right: 18
position: 0
depth: 2
updated_at: '2021-10-02T11:03:13.767Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '3'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '13'
type: taxon
attributes:
name: Tops and T-shirts
pretty_name: Categories -> Women -> Tops and T-shirts
permalink: categories/women/tops-and-t-shirts
seo_title: Tops and T-shirts
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 21
right: 22
position: 0
depth: 2
updated_at: '2021-10-02T11:03:14.340Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '3'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '10'
type: taxon
attributes:
name: Dresses
pretty_name: Categories -> Women -> Dresses
permalink: categories/women/dresses
seo_title: Dresses
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 15
right: 16
position: 0
depth: 2
updated_at: '2021-10-02T11:03:13.434Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '3'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '14'
type: taxon
attributes:
name: Jackets and Coats
pretty_name: Categories -> Women -> Jackets and Coats
permalink: categories/women/jackets-and-coats
seo_title: Jackets and Coats
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 23
right: 24
position: 0
depth: 2
updated_at: '2021-10-02T11:03:14.688Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '3'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '23'
type: taxon
attributes:
name: New Collection
pretty_name: Categories -> New Collection
permalink: categories/new-collection
seo_title: New Collection
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 44
right: 47
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.001Z'
is_root: false
is_child: true
is_leaf: false
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data:
- id: '24'
type: taxon
image:
data: null
- id: '24'
type: taxon
attributes:
name: Summer 2021
pretty_name: Categories -> New Collection -> Summer 2021
permalink: categories/new-collection/summer-2021
seo_title: Summer 2021
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 45
right: 46
position: 0
depth: 2
updated_at: '2021-10-02T11:03:15.001Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '23'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '26'
type: taxon
attributes:
name: 30% Off
pretty_name: Categories -> Special Offers -> 30% Off
permalink: categories/special-offers/30-percent-off
seo_title: 30% Off
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 49
right: 50
position: 0
depth: 2
updated_at: '2021-10-02T11:03:15.118Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '25'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '25'
type: taxon
attributes:
name: Special Offers
pretty_name: Categories -> Special Offers
permalink: categories/special-offers
seo_title: Special Offers
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 48
right: 51
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.118Z'
is_root: false
is_child: true
is_leaf: false
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data:
- id: '26'
type: taxon
image:
data: null
- id: '21'
type: taxon
attributes:
name: Streetstyle
pretty_name: Categories -> Streetstyle
permalink: categories/streetstyle
seo_title: Streetstyle
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 40
right: 41
position: 0
depth: 1
updated_at: '2021-10-02T11:03:15.146Z'
is_root: false
is_child: true
is_leaf: true
relationships:
parent:
data:
id: '1'
type: taxon
taxonomy:
data:
id: '1'
type: taxonomy
children:
data: []
image:
data: null
- id: '1'
type: taxon
attributes:
name: Categories
pretty_name: Categories
permalink: categories
seo_title: Categories
description: null
meta_title: null
meta_description: null
meta_keywords: null
left: 1
right: 52
position: 0
depth: 0
updated_at: '2021-10-02T11:03:15.146Z'
is_root: true
is_child: false
is_leaf: false
relationships:
parent:
data: null
taxonomy:
data:
id: '1'
type: taxonomy
children:
data:
- id: '2'
type: taxon
- id: '3'
type: taxon
- id: '4'
type: taxon
- id: '18'
type: taxon
- id: '19'
type: taxon
- id: '20'
type: taxon
- id: '21'
type: taxon
- id: '22'
type: taxon
- id: '23'
type: taxon
- id: '25'
type: taxon
image:
data: null
meta:
count: 25
total_count: 26
total_pages: 2
links:
self: 'http://localhost:3000/api/v2/storefront/taxons'
next: 'http://localhost:3000/api/v2/storefront/taxons?page=2'
prev: 'http://localhost:3000/api/v2/storefront/taxons?page=1'
last: 'http://localhost:3000/api/v2/storefront/taxons?page=2'
first: 'http://localhost:3000/api/v2/storefront/taxons?page=1'
Country:
description: 200 Success - Returns the `country` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Country'
included:
type: array
items:
$ref: '#/components/schemas/CountryIncludes'
required:
- data
CountryList:
description: 200 Success - Returns an array of `country` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Country'
included:
type: array
items:
$ref: '#/components/schemas/CountryIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
All Countries:
value:
data:
- id: '1'
type: country
attributes:
iso: AD
iso3: AND
iso_name: ANDORRA
name: Andorra
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '3'
type: country
attributes:
iso: AF
iso3: AFG
iso_name: AFGHANISTAN
name: Afghanistan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '5'
type: country
attributes:
iso: AI
iso3: AIA
iso_name: ANGUILLA
name: Anguilla
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '6'
type: country
attributes:
iso: AL
iso3: ALB
iso_name: ALBANIA
name: Albania
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '7'
type: country
attributes:
iso: AM
iso3: ARM
iso_name: ARMENIA
name: Armenia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '9'
type: country
attributes:
iso: AR
iso3: ARG
iso_name: ARGENTINA
name: Argentina
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '10'
type: country
attributes:
iso: AS
iso3: ASM
iso_name: AMERICAN SAMOA
name: American Samoa
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '11'
type: country
attributes:
iso: AT
iso3: AUT
iso_name: AUSTRIA
name: Austria
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '14'
type: country
attributes:
iso: AZ
iso3: AZE
iso_name: AZERBAIJAN
name: Azerbaijan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '15'
type: country
attributes:
iso: BA
iso3: BIH
iso_name: BOSNIA AND HERZEGOVINA
name: Bosnia and Herzegovina
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '16'
type: country
attributes:
iso: BB
iso3: BRB
iso_name: BARBADOS
name: Barbados
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '17'
type: country
attributes:
iso: BD
iso3: BGD
iso_name: BANGLADESH
name: Bangladesh
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '18'
type: country
attributes:
iso: BE
iso3: BEL
iso_name: BELGIUM
name: Belgium
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '20'
type: country
attributes:
iso: BG
iso3: BGR
iso_name: BULGARIA
name: Bulgaria
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '21'
type: country
attributes:
iso: BH
iso3: BHR
iso_name: BAHRAIN
name: Bahrain
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '24'
type: country
attributes:
iso: BL
iso3: BLM
iso_name: SAINT BARTHÉLEMY
name: Saint Barthélemy
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '26'
type: country
attributes:
iso: BN
iso3: BRN
iso_name: BRUNEI DARUSSALAM
name: Brunei Darussalam
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '28'
type: country
attributes:
iso: BQ
iso3: BES
iso_name: 'BONAIRE, SINT EUSTATIUS AND SABA'
name: 'Bonaire, Sint Eustatius and Saba'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '31'
type: country
attributes:
iso: BT
iso3: BTN
iso_name: BHUTAN
name: Bhutan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '33'
type: country
attributes:
iso: BY
iso3: BLR
iso_name: BELARUS
name: Belarus
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '36'
type: country
attributes:
iso: CC
iso3: CCK
iso_name: COCOS (KEELING) ISLANDS
name: Cocos (Keeling) Islands
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '40'
type: country
attributes:
iso: CH
iso3: CHE
iso_name: SWITZERLAND
name: Switzerland
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '43'
type: country
attributes:
iso: CL
iso3: CHL
iso_name: CHILE
name: Chile
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '46'
type: country
attributes:
iso: CO
iso3: COL
iso_name: COLOMBIA
name: Colombia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '47'
type: country
attributes:
iso: CR
iso3: CRI
iso_name: COSTA RICA
name: Costa Rica
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '48'
type: country
attributes:
iso: CU
iso3: CUB
iso_name: CUBA
name: Cuba
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '49'
type: country
attributes:
iso: CV
iso3: CPV
iso_name: CABO VERDE
name: Cabo Verde
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '50'
type: country
attributes:
iso: CW
iso3: CUW
iso_name: CURAÇAO
name: Curaçao
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '51'
type: country
attributes:
iso: CX
iso3: CXR
iso_name: CHRISTMAS ISLAND
name: Christmas Island
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '52'
type: country
attributes:
iso: CY
iso3: CYP
iso_name: CYPRUS
name: Cyprus
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '53'
type: country
attributes:
iso: CZ
iso3: CZE
iso_name: CZECHIA
name: Czechia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '54'
type: country
attributes:
iso: DE
iso3: DEU
iso_name: GERMANY
name: Germany
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '56'
type: country
attributes:
iso: DK
iso3: DNK
iso_name: DENMARK
name: Denmark
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '58'
type: country
attributes:
iso: DO
iso3: DOM
iso_name: DOMINICAN REPUBLIC
name: Dominican Republic
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '59'
type: country
attributes:
iso: DZ
iso3: DZA
iso_name: ALGERIA
name: Algeria
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '60'
type: country
attributes:
iso: EC
iso3: ECU
iso_name: ECUADOR
name: Ecuador
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '61'
type: country
attributes:
iso: EE
iso3: EST
iso_name: ESTONIA
name: Estonia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '62'
type: country
attributes:
iso: EG
iso3: EGY
iso_name: EGYPT
name: Egypt
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '65'
type: country
attributes:
iso: ET
iso3: ETH
iso_name: ETHIOPIA
name: Ethiopia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '66'
type: country
attributes:
iso: FI
iso3: FIN
iso_name: FINLAND
name: Finland
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '68'
type: country
attributes:
iso: FK
iso3: FLK
iso_name: FALKLAND ISLANDS (MALVINAS)
name: Falkland Islands (Malvinas)
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '69'
type: country
attributes:
iso: FM
iso3: FSM
iso_name: 'MICRONESIA, FEDERATED STATES OF'
name: 'Micronesia, Federated States of'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '70'
type: country
attributes:
iso: FO
iso3: FRO
iso_name: FAROE ISLANDS
name: Faroe Islands
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '71'
type: country
attributes:
iso: FR
iso3: FRA
iso_name: FRANCE
name: France
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '72'
type: country
attributes:
iso: GA
iso3: GAB
iso_name: GABON
name: Gabon
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '73'
type: country
attributes:
iso: GB
iso3: GBR
iso_name: UNITED KINGDOM
name: United Kingdom
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '75'
type: country
attributes:
iso: GE
iso3: GEO
iso_name: GEORGIA
name: Georgia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '76'
type: country
attributes:
iso: GF
iso3: GUF
iso_name: FRENCH GUIANA
name: French Guiana
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '77'
type: country
attributes:
iso: GG
iso3: GGY
iso_name: GUERNSEY
name: Guernsey
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '79'
type: country
attributes:
iso: GI
iso3: GIB
iso_name: GIBRALTAR
name: Gibraltar
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '80'
type: country
attributes:
iso: GL
iso3: GRL
iso_name: GREENLAND
name: Greenland
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '83'
type: country
attributes:
iso: GP
iso3: GLP
iso_name: GUADELOUPE
name: Guadeloupe
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '85'
type: country
attributes:
iso: GR
iso3: GRC
iso_name: GREECE
name: Greece
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '86'
type: country
attributes:
iso: GT
iso3: GTM
iso_name: GUATEMALA
name: Guatemala
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '87'
type: country
attributes:
iso: GU
iso3: GUM
iso_name: GUAM
name: Guam
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '88'
type: country
attributes:
iso: GW
iso3: GNB
iso_name: GUINEA-BISSAU
name: Guinea-Bissau
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '91'
type: country
attributes:
iso: HN
iso3: HND
iso_name: HONDURAS
name: Honduras
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '92'
type: country
attributes:
iso: HR
iso3: HRV
iso_name: CROATIA
name: Croatia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '93'
type: country
attributes:
iso: HT
iso3: HTI
iso_name: HAITI
name: Haiti
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '94'
type: country
attributes:
iso: HU
iso3: HUN
iso_name: HUNGARY
name: Hungary
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '95'
type: country
attributes:
iso: ID
iso3: IDN
iso_name: INDONESIA
name: Indonesia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '97'
type: country
attributes:
iso: IL
iso3: ISR
iso_name: ISRAEL
name: Israel
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '98'
type: country
attributes:
iso: IM
iso3: IMN
iso_name: ISLE OF MAN
name: Isle of Man
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '100'
type: country
attributes:
iso: IQ
iso3: IRQ
iso_name: IRAQ
name: Iraq
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '101'
type: country
attributes:
iso: IR
iso3: IRN
iso_name: 'IRAN, ISLAMIC REPUBLIC OF'
name: 'Iran, Islamic Republic of'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '102'
type: country
attributes:
iso: IS
iso3: ISL
iso_name: ICELAND
name: Iceland
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '104'
type: country
attributes:
iso: JE
iso3: JEY
iso_name: JERSEY
name: Jersey
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '105'
type: country
attributes:
iso: JM
iso3: JAM
iso_name: JAMAICA
name: Jamaica
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '106'
type: country
attributes:
iso: JO
iso3: JOR
iso_name: JORDAN
name: Jordan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '107'
type: country
attributes:
iso: JP
iso3: JPN
iso_name: JAPAN
name: Japan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '108'
type: country
attributes:
iso: KE
iso3: KEN
iso_name: KENYA
name: Kenya
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '109'
type: country
attributes:
iso: KG
iso3: KGZ
iso_name: KYRGYZSTAN
name: Kyrgyzstan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '110'
type: country
attributes:
iso: KH
iso3: KHM
iso_name: CAMBODIA
name: Cambodia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '115'
type: country
attributes:
iso: KR
iso3: KOR
iso_name: 'KOREA, REPUBLIC OF'
name: 'Korea, Republic of'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '116'
type: country
attributes:
iso: KW
iso3: KWT
iso_name: KUWAIT
name: Kuwait
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '117'
type: country
attributes:
iso: KY
iso3: CYM
iso_name: CAYMAN ISLANDS
name: Cayman Islands
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '118'
type: country
attributes:
iso: KZ
iso3: KAZ
iso_name: KAZAKHSTAN
name: Kazakhstan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '119'
type: country
attributes:
iso: LA
iso3: LAO
iso_name: LAO PEOPLE'S DEMOCRATIC REPUBLIC
name: Lao People's Democratic Republic
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '120'
type: country
attributes:
iso: LB
iso3: LBN
iso_name: LEBANON
name: Lebanon
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '122'
type: country
attributes:
iso: LI
iso3: LIE
iso_name: LIECHTENSTEIN
name: Liechtenstein
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '123'
type: country
attributes:
iso: LK
iso3: LKA
iso_name: SRI LANKA
name: Sri Lanka
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '124'
type: country
attributes:
iso: LR
iso3: LBR
iso_name: LIBERIA
name: Liberia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '125'
type: country
attributes:
iso: LS
iso3: LSO
iso_name: LESOTHO
name: Lesotho
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '126'
type: country
attributes:
iso: LT
iso3: LTU
iso_name: LITHUANIA
name: Lithuania
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '127'
type: country
attributes:
iso: LU
iso3: LUX
iso_name: LUXEMBOURG
name: Luxembourg
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '128'
type: country
attributes:
iso: LV
iso3: LVA
iso_name: LATVIA
name: Latvia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '130'
type: country
attributes:
iso: MA
iso3: MAR
iso_name: MOROCCO
name: Morocco
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '131'
type: country
attributes:
iso: MC
iso3: MCO
iso_name: MONACO
name: Monaco
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '132'
type: country
attributes:
iso: MD
iso3: MDA
iso_name: 'MOLDOVA, REPUBLIC OF'
name: 'Moldova, Republic of'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '133'
type: country
attributes:
iso: ME
iso3: MNE
iso_name: MONTENEGRO
name: Montenegro
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '134'
type: country
attributes:
iso: MF
iso3: MAF
iso_name: SAINT MARTIN (FRENCH PART)
name: Saint Martin (French part)
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '135'
type: country
attributes:
iso: MG
iso3: MDG
iso_name: MADAGASCAR
name: Madagascar
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '136'
type: country
attributes:
iso: MH
iso3: MHL
iso_name: MARSHALL ISLANDS
name: Marshall Islands
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '137'
type: country
attributes:
iso: MK
iso3: MKD
iso_name: NORTH MACEDONIA
name: North Macedonia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '139'
type: country
attributes:
iso: MM
iso3: MMR
iso_name: MYANMAR
name: Myanmar
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '140'
type: country
attributes:
iso: MN
iso3: MNG
iso_name: MONGOLIA
name: Mongolia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '142'
type: country
attributes:
iso: MP
iso3: MNP
iso_name: NORTHERN MARIANA ISLANDS
name: Northern Mariana Islands
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '143'
type: country
attributes:
iso: MQ
iso3: MTQ
iso_name: MARTINIQUE
name: Martinique
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '145'
type: country
attributes:
iso: MS
iso3: MSR
iso_name: MONTSERRAT
name: Montserrat
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '146'
type: country
attributes:
iso: MT
iso3: MLT
iso_name: MALTA
name: Malta
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '147'
type: country
attributes:
iso: MU
iso3: MUS
iso_name: MAURITIUS
name: Mauritius
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '148'
type: country
attributes:
iso: MV
iso3: MDV
iso_name: MALDIVES
name: Maldives
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '152'
type: country
attributes:
iso: MZ
iso3: MOZ
iso_name: MOZAMBIQUE
name: Mozambique
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '153'
type: country
attributes:
iso: NA
iso3: NAM
iso_name: NAMIBIA
name: Namibia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '154'
type: country
attributes:
iso: NC
iso3: NCL
iso_name: NEW CALEDONIA
name: New Caledonia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '155'
type: country
attributes:
iso: NE
iso3: NER
iso_name: NIGER
name: Niger
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '156'
type: country
attributes:
iso: NF
iso3: NFK
iso_name: NORFOLK ISLAND
name: Norfolk Island
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '157'
type: country
attributes:
iso: NG
iso3: NGA
iso_name: NIGERIA
name: Nigeria
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '158'
type: country
attributes:
iso: NI
iso3: NIC
iso_name: NICARAGUA
name: Nicaragua
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '159'
type: country
attributes:
iso: NL
iso3: NLD
iso_name: NETHERLANDS
name: Netherlands
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '160'
type: country
attributes:
iso: 'NO'
iso3: NOR
iso_name: NORWAY
name: Norway
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '161'
type: country
attributes:
iso: NP
iso3: NPL
iso_name: NEPAL
name: Nepal
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '165'
type: country
attributes:
iso: OM
iso3: OMN
iso_name: OMAN
name: Oman
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '167'
type: country
attributes:
iso: PE
iso3: PER
iso_name: PERU
name: Peru
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '168'
type: country
attributes:
iso: PF
iso3: PYF
iso_name: FRENCH POLYNESIA
name: French Polynesia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '169'
type: country
attributes:
iso: PG
iso3: PNG
iso_name: PAPUA NEW GUINEA
name: Papua New Guinea
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '170'
type: country
attributes:
iso: PH
iso3: PHL
iso_name: PHILIPPINES
name: Philippines
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '171'
type: country
attributes:
iso: PK
iso3: PAK
iso_name: PAKISTAN
name: Pakistan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '172'
type: country
attributes:
iso: PL
iso3: POL
iso_name: POLAND
name: Poland
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '173'
type: country
attributes:
iso: PM
iso3: SPM
iso_name: SAINT PIERRE AND MIQUELON
name: Saint Pierre and Miquelon
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '174'
type: country
attributes:
iso: PN
iso3: PCN
iso_name: PITCAIRN
name: Pitcairn
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '175'
type: country
attributes:
iso: PR
iso3: PRI
iso_name: PUERTO RICO
name: Puerto Rico
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '176'
type: country
attributes:
iso: PS
iso3: PSE
iso_name: 'PALESTINE, STATE OF'
name: 'Palestine, State of'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '178'
type: country
attributes:
iso: PW
iso3: PLW
iso_name: PALAU
name: Palau
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '179'
type: country
attributes:
iso: PY
iso3: PRY
iso_name: PARAGUAY
name: Paraguay
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '181'
type: country
attributes:
iso: RE
iso3: REU
iso_name: RÉUNION
name: Réunion
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '183'
type: country
attributes:
iso: RS
iso3: SRB
iso_name: SERBIA
name: Serbia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '184'
type: country
attributes:
iso: RU
iso3: RUS
iso_name: RUSSIA
name: Russia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '186'
type: country
attributes:
iso: SA
iso3: SAU
iso_name: SAUDI ARABIA
name: Saudi Arabia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '189'
type: country
attributes:
iso: SD
iso3: SDN
iso_name: SUDAN
name: Sudan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '190'
type: country
attributes:
iso: SE
iso3: SWE
iso_name: SWEDEN
name: Sweden
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '191'
type: country
attributes:
iso: SG
iso3: SGP
iso_name: SINGAPORE
name: Singapore
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '111'
type: country
attributes:
iso: KI
iso3: KIR
iso_name: KIRIBATI
name: Kiribati
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '192'
type: country
attributes:
iso: SH
iso3: SHN
iso_name: 'SAINT HELENA, ASCENSION AND TRISTAN DA CUNHA'
name: 'Saint Helena, Ascension and Tristan da Cunha'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '193'
type: country
attributes:
iso: SI
iso3: SVN
iso_name: SLOVENIA
name: Slovenia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '194'
type: country
attributes:
iso: SJ
iso3: SJM
iso_name: SVALBARD AND JAN MAYEN
name: Svalbard and Jan Mayen
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '195'
type: country
attributes:
iso: SK
iso3: SVK
iso_name: SLOVAKIA
name: Slovakia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '197'
type: country
attributes:
iso: SM
iso3: SMR
iso_name: SAN MARINO
name: San Marino
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '198'
type: country
attributes:
iso: SN
iso3: SEN
iso_name: SENEGAL
name: Senegal
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '201'
type: country
attributes:
iso: SS
iso3: SSD
iso_name: SOUTH SUDAN
name: South Sudan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '203'
type: country
attributes:
iso: SV
iso3: SLV
iso_name: EL SALVADOR
name: El Salvador
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '204'
type: country
attributes:
iso: SX
iso3: SXM
iso_name: SINT MAARTEN (DUTCH PART)
name: Sint Maarten (Dutch part)
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '206'
type: country
attributes:
iso: SZ
iso3: SWZ
iso_name: ESWATINI
name: Eswatini
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '207'
type: country
attributes:
iso: TC
iso3: TCA
iso_name: TURKS AND CAICOS ISLANDS
name: Turks and Caicos Islands
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '208'
type: country
attributes:
iso: TD
iso3: TCD
iso_name: CHAD
name: Chad
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '211'
type: country
attributes:
iso: TJ
iso3: TJK
iso_name: TAJIKISTAN
name: Tajikistan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '214'
type: country
attributes:
iso: TM
iso3: TKM
iso_name: TURKMENISTAN
name: Turkmenistan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '215'
type: country
attributes:
iso: TN
iso3: TUN
iso_name: TUNISIA
name: Tunisia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '217'
type: country
attributes:
iso: TR
iso3: TUR
iso_name: TURKEY
name: Turkey
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '218'
type: country
attributes:
iso: TT
iso3: TTO
iso_name: TRINIDAD AND TOBAGO
name: Trinidad and Tobago
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '220'
type: country
attributes:
iso: TW
iso3: TWN
iso_name: TAIWAN
name: Taiwan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '222'
type: country
attributes:
iso: UA
iso3: UKR
iso_name: UKRAINE
name: Ukraine
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '225'
type: country
attributes:
iso: UY
iso3: URY
iso_name: URUGUAY
name: Uruguay
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '226'
type: country
attributes:
iso: UZ
iso3: UZB
iso_name: UZBEKISTAN
name: Uzbekistan
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '227'
type: country
attributes:
iso: VA
iso3: VAT
iso_name: HOLY SEE (VATICAN CITY STATE)
name: Holy See (Vatican City State)
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '228'
type: country
attributes:
iso: VC
iso3: VCT
iso_name: SAINT VINCENT AND THE GRENADINES
name: Saint Vincent and the Grenadines
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '229'
type: country
attributes:
iso: VE
iso3: VEN
iso_name: 'VENEZUELA, BOLIVARIAN REPUBLIC OF'
name: 'Venezuela, Bolivarian Republic of'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '230'
type: country
attributes:
iso: VG
iso3: VGB
iso_name: 'VIRGIN ISLANDS, BRITISH'
name: 'Virgin Islands, British'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '231'
type: country
attributes:
iso: VI
iso3: VIR
iso_name: 'VIRGIN ISLANDS, U.S.'
name: 'Virgin Islands, U.S.'
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '232'
type: country
attributes:
iso: VN
iso3: VNM
iso_name: VIETNAM
name: Vietnam
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '234'
type: country
attributes:
iso: WF
iso3: WLF
iso_name: WALLIS AND FUTUNA
name: Wallis and Futuna
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '235'
type: country
attributes:
iso: WS
iso3: WSM
iso_name: SAMOA
name: Samoa
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '237'
type: country
attributes:
iso: YT
iso3: MYT
iso_name: MAYOTTE
name: Mayotte
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '239'
type: country
attributes:
iso: ZM
iso3: ZMB
iso_name: ZAMBIA
name: Zambia
states_required: false
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '4'
type: country
attributes:
iso: AG
iso3: ATG
iso_name: ANTIGUA AND BARBUDA
name: Antigua and Barbuda
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '8'
type: country
attributes:
iso: AO
iso3: AGO
iso_name: ANGOLA
name: Angola
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '13'
type: country
attributes:
iso: AW
iso3: ABW
iso_name: ARUBA
name: Aruba
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '19'
type: country
attributes:
iso: BF
iso3: BFA
iso_name: BURKINA FASO
name: Burkina Faso
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '22'
type: country
attributes:
iso: BI
iso3: BDI
iso_name: BURUNDI
name: Burundi
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '23'
type: country
attributes:
iso: BJ
iso3: BEN
iso_name: BENIN
name: Benin
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '25'
type: country
attributes:
iso: BM
iso3: BMU
iso_name: BERMUDA
name: Bermuda
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '27'
type: country
attributes:
iso: BO
iso3: BOL
iso_name: 'BOLIVIA, PLURINATIONAL STATE OF'
name: 'Bolivia, Plurinational State of'
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '30'
type: country
attributes:
iso: BS
iso3: BHS
iso_name: BAHAMAS
name: Bahamas
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '32'
type: country
attributes:
iso: BW
iso3: BWA
iso_name: BOTSWANA
name: Botswana
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '34'
type: country
attributes:
iso: BZ
iso3: BLZ
iso_name: BELIZE
name: Belize
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '37'
type: country
attributes:
iso: CD
iso3: COD
iso_name: 'CONGO, THE DEMOCRATIC REPUBLIC OF THE'
name: 'Congo, The Democratic Republic of the'
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '38'
type: country
attributes:
iso: CF
iso3: CAF
iso_name: CENTRAL AFRICAN REPUBLIC
name: Central African Republic
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '39'
type: country
attributes:
iso: CG
iso3: COG
iso_name: CONGO
name: Congo
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '41'
type: country
attributes:
iso: CI
iso3: CIV
iso_name: CÔTE D'IVOIRE
name: Côte d'Ivoire
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '42'
type: country
attributes:
iso: CK
iso3: COK
iso_name: COOK ISLANDS
name: Cook Islands
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '44'
type: country
attributes:
iso: CM
iso3: CMR
iso_name: CAMEROON
name: Cameroon
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '55'
type: country
attributes:
iso: DJ
iso3: DJI
iso_name: DJIBOUTI
name: Djibouti
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '57'
type: country
attributes:
iso: DM
iso3: DMA
iso_name: DOMINICA
name: Dominica
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '63'
type: country
attributes:
iso: ER
iso3: ERI
iso_name: ERITREA
name: Eritrea
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '67'
type: country
attributes:
iso: FJ
iso3: FJI
iso_name: FIJI
name: Fiji
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '74'
type: country
attributes:
iso: GD
iso3: GRD
iso_name: GRENADA
name: Grenada
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '78'
type: country
attributes:
iso: GH
iso3: GHA
iso_name: GHANA
name: Ghana
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '81'
type: country
attributes:
iso: GM
iso3: GMB
iso_name: GAMBIA
name: Gambia
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '82'
type: country
attributes:
iso: GN
iso3: GIN
iso_name: GUINEA
name: Guinea
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '84'
type: country
attributes:
iso: GQ
iso3: GNQ
iso_name: EQUATORIAL GUINEA
name: Equatorial Guinea
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '89'
type: country
attributes:
iso: GY
iso3: GUY
iso_name: GUYANA
name: Guyana
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '112'
type: country
attributes:
iso: KM
iso3: COM
iso_name: COMOROS
name: Comoros
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '113'
type: country
attributes:
iso: KN
iso3: KNA
iso_name: SAINT KITTS AND NEVIS
name: Saint Kitts and Nevis
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '114'
type: country
attributes:
iso: KP
iso3: PRK
iso_name: 'KOREA, DEMOCRATIC PEOPLE''S REPUBLIC OF'
name: 'Korea, Democratic People''s Republic of'
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '121'
type: country
attributes:
iso: LC
iso3: LCA
iso_name: SAINT LUCIA
name: Saint Lucia
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '129'
type: country
attributes:
iso: LY
iso3: LBY
iso_name: LIBYA
name: Libya
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '138'
type: country
attributes:
iso: ML
iso3: MLI
iso_name: MALI
name: Mali
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '141'
type: country
attributes:
iso: MO
iso3: MAC
iso_name: MACAO
name: Macao
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '144'
type: country
attributes:
iso: MR
iso3: MRT
iso_name: MAURITANIA
name: Mauritania
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '149'
type: country
attributes:
iso: MW
iso3: MWI
iso_name: MALAWI
name: Malawi
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '162'
type: country
attributes:
iso: NR
iso3: NRU
iso_name: NAURU
name: Nauru
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '163'
type: country
attributes:
iso: NU
iso3: NIU
iso_name: NIUE
name: Niue
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '166'
type: country
attributes:
iso: PA
iso3: PAN
iso_name: PANAMA
name: Panama
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '180'
type: country
attributes:
iso: QA
iso3: QAT
iso_name: QATAR
name: Qatar
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '185'
type: country
attributes:
iso: RW
iso3: RWA
iso_name: RWANDA
name: Rwanda
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '187'
type: country
attributes:
iso: SB
iso3: SLB
iso_name: SOLOMON ISLANDS
name: Solomon Islands
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '188'
type: country
attributes:
iso: SC
iso3: SYC
iso_name: SEYCHELLES
name: Seychelles
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '196'
type: country
attributes:
iso: SL
iso3: SLE
iso_name: SIERRA LEONE
name: Sierra Leone
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '199'
type: country
attributes:
iso: SO
iso3: SOM
iso_name: SOMALIA
name: Somalia
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '200'
type: country
attributes:
iso: SR
iso3: SUR
iso_name: SURINAME
name: Suriname
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '202'
type: country
attributes:
iso: ST
iso3: STP
iso_name: SAO TOME AND PRINCIPE
name: Sao Tome and Principe
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '205'
type: country
attributes:
iso: SY
iso3: SYR
iso_name: SYRIAN ARAB REPUBLIC
name: Syrian Arab Republic
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '209'
type: country
attributes:
iso: TG
iso3: TGO
iso_name: TOGO
name: Togo
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '212'
type: country
attributes:
iso: TK
iso3: TKL
iso_name: TOKELAU
name: Tokelau
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '213'
type: country
attributes:
iso: TL
iso3: TLS
iso_name: TIMOR-LESTE
name: Timor-Leste
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '216'
type: country
attributes:
iso: TO
iso3: TON
iso_name: TONGA
name: Tonga
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '219'
type: country
attributes:
iso: TV
iso3: TUV
iso_name: TUVALU
name: Tuvalu
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '221'
type: country
attributes:
iso: TZ
iso3: TZA
iso_name: 'TANZANIA, UNITED REPUBLIC OF'
name: 'Tanzania, United Republic of'
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '223'
type: country
attributes:
iso: UG
iso3: UGA
iso_name: UGANDA
name: Uganda
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '233'
type: country
attributes:
iso: VU
iso3: VUT
iso_name: VANUATU
name: Vanuatu
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '236'
type: country
attributes:
iso: YE
iso3: YEM
iso_name: YEMEN
name: Yemen
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '240'
type: country
attributes:
iso: ZW
iso3: ZWE
iso_name: ZIMBABWE
name: Zimbabwe
states_required: false
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '12'
type: country
attributes:
iso: AU
iso3: AUS
iso_name: AUSTRALIA
name: Australia
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '29'
type: country
attributes:
iso: BR
iso3: BRA
iso_name: BRAZIL
name: Brazil
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '35'
type: country
attributes:
iso: CA
iso3: CAN
iso_name: CANADA
name: Canada
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data:
- id: '36'
type: state
- id: '37'
type: state
- id: '38'
type: state
- id: '39'
type: state
- id: '40'
type: state
- id: '42'
type: state
- id: '41'
type: state
- id: '43'
type: state
- id: '44'
type: state
- id: '45'
type: state
- id: '46'
type: state
- id: '47'
type: state
- id: '48'
type: state
- id: '45'
type: country
attributes:
iso: CN
iso3: CHN
iso_name: CHINA
name: China
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '64'
type: country
attributes:
iso: ES
iso3: ESP
iso_name: SPAIN
name: Spain
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '99'
type: country
attributes:
iso: IN
iso3: IND
iso_name: INDIA
name: India
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '103'
type: country
attributes:
iso: IT
iso3: ITA
iso_name: ITALY
name: Italy
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '150'
type: country
attributes:
iso: MX
iso3: MEX
iso_name: MEXICO
name: Mexico
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '151'
type: country
attributes:
iso: MY
iso3: MYS
iso_name: MALAYSIA
name: Malaysia
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '164'
type: country
attributes:
iso: NZ
iso3: NZL
iso_name: NEW ZEALAND
name: New Zealand
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '177'
type: country
attributes:
iso: PT
iso3: PRT
iso_name: PORTUGAL
name: Portugal
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '182'
type: country
attributes:
iso: RO
iso3: ROU
iso_name: ROMANIA
name: Romania
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '210'
type: country
attributes:
iso: TH
iso3: THA
iso_name: THAILAND
name: Thailand
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '224'
type: country
attributes:
iso: US
iso3: USA
iso_name: UNITED STATES
name: United States
states_required: true
zipcode_required: true
default: true
relationships:
checkout_zone_applicable_states:
data:
- id: '483'
type: state
- id: '482'
type: state
- id: '485'
type: state
- id: '484'
type: state
- id: '534'
type: state
- id: '533'
type: state
- id: '535'
type: state
- id: '486'
type: state
- id: '487'
type: state
- id: '488'
type: state
- id: '490'
type: state
- id: '489'
type: state
- id: '491'
type: state
- id: '492'
type: state
- id: '493'
type: state
- id: '495'
type: state
- id: '496'
type: state
- id: '497'
type: state
- id: '494'
type: state
- id: '498'
type: state
- id: '499'
type: state
- id: '500'
type: state
- id: '503'
type: state
- id: '502'
type: state
- id: '501'
type: state
- id: '504'
type: state
- id: '505'
type: state
- id: '507'
type: state
- id: '506'
type: state
- id: '508'
type: state
- id: '511'
type: state
- id: '515'
type: state
- id: '512'
type: state
- id: '513'
type: state
- id: '514'
type: state
- id: '516'
type: state
- id: '509'
type: state
- id: '510'
type: state
- id: '517'
type: state
- id: '518'
type: state
- id: '519'
type: state
- id: '520'
type: state
- id: '521'
type: state
- id: '522'
type: state
- id: '523'
type: state
- id: '524'
type: state
- id: '525'
type: state
- id: '526'
type: state
- id: '528'
type: state
- id: '527'
type: state
- id: '529'
type: state
- id: '531'
type: state
- id: '530'
type: state
- id: '532'
type: state
- id: '238'
type: country
attributes:
iso: ZA
iso3: ZAF
iso_name: SOUTH AFRICA
name: South Africa
states_required: true
zipcode_required: true
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '2'
type: country
attributes:
iso: AE
iso3: ARE
iso_name: UNITED ARAB EMIRATES
name: United Arab Emirates
states_required: true
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '90'
type: country
attributes:
iso: HK
iso3: HKG
iso_name: HONG KONG
name: Hong Kong
states_required: true
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
- id: '96'
type: country
attributes:
iso: IE
iso3: IRL
iso_name: IRELAND
name: Ireland
states_required: true
zipcode_required: false
default: false
relationships:
checkout_zone_applicable_states:
data: []
meta:
count: 240
total_count: 240
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/countries'
next: 'http://localhost:3000/api/v2/storefront/countries?page=1&per_page=240'
prev: 'http://localhost:3000/api/v2/storefront/countries?page=1&per_page=240'
last: 'http://localhost:3000/api/v2/storefront/countries?page=1&per_page=240'
first: 'http://localhost:3000/api/v2/storefront/countries?page=1&per_page=240'
Shipment:
description: '200 Success - Returns an array containing several `shipment` objects, along with the included array containing all available `shipping_rate` and `stock_location` objects. '
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Shipment'
included:
type: array
items:
$ref: '#/components/schemas/ShipmentIncludes'
required:
- data
- included
examples:
Shipment:
value:
data:
- id: '3'
type: shipment
attributes:
number: H97593072360
final_price: '5.0'
display_final_price: $5.00
state: pending
shipped_at: null
tracking_url: null
free: false
relationships:
shipping_rates:
data:
- id: '10'
type: shipping_rate
- id: '11'
type: shipping_rate
- id: '12'
type: shipping_rate
stock_location:
data:
id: '1'
type: stock_location
included:
- id: '10'
type: shipping_rate
attributes:
name: UPS Ground (USD)
selected: true
final_price: '5.0'
display_final_price: $5.00
cost: '5.0'
display_cost: $5.00
tax_amount: '0.0'
display_tax_amount: $0.00
shipping_method_id: 1
free: false
- id: '11'
type: shipping_rate
attributes:
name: UPS Two Day (USD)
selected: false
final_price: '10.0'
display_final_price: $10.00
cost: '10.0'
display_cost: $10.00
tax_amount: '0.0'
display_tax_amount: $0.00
shipping_method_id: 2
free: false
- id: '12'
type: shipping_rate
attributes:
name: UPS One Day (USD)
selected: false
final_price: '15.0'
display_final_price: $15.00
cost: '15.0'
display_cost: $15.00
tax_amount: '0.0'
display_tax_amount: $0.00
shipping_method_id: 3
free: false
- id: '1'
type: stock_location
attributes:
name: default
EstimatedShippingRates:
description: 200 Success - Returns an array of `shipping_rate` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ShippingRate'
required:
- data
examples:
Estimated Shipping Rates:
value:
data:
- id: null
type: shipping_rate
attributes:
name: UPS Ground (USD)
selected: true
cost: '5.0'
tax_amount: '0.0'
shipping_method_id: 1
final_price: '5.0'
display_cost: $5.00
display_final_price: $5.00
display_tax_amount: $0.00
free: false
- id: null
type: shipping_rate
attributes:
name: UPS Two Day (USD)
selected: false
cost: '10.0'
tax_amount: '0.0'
shipping_method_id: 2
final_price: '10.0'
display_cost: $10.00
display_final_price: $10.00
display_tax_amount: $0.00
free: false
- id: null
type: shipping_rate
attributes:
name: UPS One Day (USD)
selected: false
cost: '15.0'
tax_amount: '0.0'
shipping_method_id: 3
final_price: '15.0'
display_cost: $15.00
display_final_price: $15.00
display_tax_amount: $0.00
free: false
Menu:
description: 200 Success - Returns the `menu` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Menu'
included:
type: array
items:
$ref: '#/components/schemas/MenuIncludes'
required:
- data
examples:
Retrieve a single Menu:
value:
data:
id: '2'
type: menu
attributes:
name: Footer Menu
location: footer
locale: en
relationships:
menu_items:
data:
- id: '46'
type: menu_item
- id: '45'
type: menu_item
- id: '44'
type: menu_item
- id: '47'
type: menu_item
- id: '48'
type: menu_item
- id: '41'
type: menu_item
- id: '49'
type: menu_item
- id: '50'
type: menu_item
- id: '51'
type: menu_item
- id: '52'
type: menu_item
- id: '42'
type: menu_item
- id: '53'
type: menu_item
- id: '54'
type: menu_item
- id: '56'
type: menu_item
- id: '55'
type: menu_item
- id: '43'
type: menu_item
- id: '2'
type: menu_item
Menu including Menu Items:
value:
data:
id: '2'
type: menu
attributes:
name: Footer Menu
location: footer
locale: en
relationships:
menu_items:
data:
- id: '46'
type: menu_item
- id: '45'
type: menu_item
- id: '44'
type: menu_item
- id: '47'
type: menu_item
- id: '48'
type: menu_item
- id: '41'
type: menu_item
- id: '49'
type: menu_item
- id: '50'
type: menu_item
- id: '51'
type: menu_item
- id: '52'
type: menu_item
- id: '42'
type: menu_item
- id: '53'
type: menu_item
- id: '54'
type: menu_item
- id: '56'
type: menu_item
- id: '55'
type: menu_item
- id: '43'
type: menu_item
- id: '2'
type: menu_item
included:
- id: '46'
type: menu_item
attributes:
code: null
name: Skirts and Blouses
subtitle: null
link: /t/categories/women/shirts-and-blouses
destination: null
item_type: Link
new_window: false
lft: 65
rgt: 66
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '41'
type: menu_item
linked_resource:
data:
id: '11'
type: taxon
children:
data: []
- id: '45'
type: menu_item
attributes:
code: null
name: Dresses
subtitle: null
link: /t/categories/women/dresses
destination: null
item_type: Link
new_window: false
lft: 63
rgt: 64
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '41'
type: menu_item
linked_resource:
data:
id: '10'
type: taxon
children:
data: []
- id: '44'
type: menu_item
attributes:
code: null
name: Skirts
subtitle: null
link: /t/categories/women/skirts
destination: null
item_type: Link
new_window: false
lft: 61
rgt: 62
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '41'
type: menu_item
linked_resource:
data:
id: '9'
type: taxon
children:
data: []
- id: '47'
type: menu_item
attributes:
code: null
name: Sweaters
subtitle: null
link: /t/categories/women/sweaters
destination: null
item_type: Link
new_window: false
lft: 67
rgt: 68
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '41'
type: menu_item
linked_resource:
data:
id: '12'
type: taxon
children:
data: []
- id: '48'
type: menu_item
attributes:
code: null
name: Tops and T-Shirts
subtitle: null
link: /t/categories/women/tops-and-t-shirts
destination: null
item_type: Link
new_window: false
lft: 69
rgt: 70
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '41'
type: menu_item
linked_resource:
data:
id: '13'
type: taxon
children:
data: []
- id: '41'
type: menu_item
attributes:
code: null
name: Women
subtitle: null
link: /t/categories/women
destination: null
item_type: Link
new_window: false
lft: 60
rgt: 73
depth: 1
is_container: false
is_root: false
is_child: true
is_leaf: false
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '2'
type: menu_item
linked_resource:
data:
id: '3'
type: taxon
children:
data:
- id: '44'
type: menu_item
- id: '45'
type: menu_item
- id: '46'
type: menu_item
- id: '47'
type: menu_item
- id: '48'
type: menu_item
- id: '49'
type: menu_item
- id: '49'
type: menu_item
attributes:
code: null
name: Jackets and Coats
subtitle: null
link: /t/categories/women/jackets-and-coats
destination: null
item_type: Link
new_window: false
lft: 71
rgt: 72
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '41'
type: menu_item
linked_resource:
data:
id: '14'
type: taxon
children:
data: []
- id: '50'
type: menu_item
attributes:
code: null
name: Shirts
subtitle: null
link: /t/categories/men/shirts
destination: null
item_type: Link
new_window: false
lft: 75
rgt: 76
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '42'
type: menu_item
linked_resource:
data:
id: '5'
type: taxon
children:
data: []
- id: '51'
type: menu_item
attributes:
code: null
name: T-Shirts
subtitle: null
link: /t/categories/men/t-shirts
destination: null
item_type: Link
new_window: false
lft: 77
rgt: 78
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '42'
type: menu_item
linked_resource:
data:
id: '6'
type: taxon
children:
data: []
- id: '52'
type: menu_item
attributes:
code: null
name: Sweaters
subtitle: null
link: /t/categories/men/sweaters
destination: null
item_type: Link
new_window: false
lft: 79
rgt: 80
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '42'
type: menu_item
linked_resource:
data:
id: '7'
type: taxon
children:
data: []
- id: '42'
type: menu_item
attributes:
code: null
name: Men
subtitle: null
link: /t/categories/men
destination: null
item_type: Link
new_window: false
lft: 74
rgt: 83
depth: 1
is_container: false
is_root: false
is_child: true
is_leaf: false
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '2'
type: menu_item
linked_resource:
data:
id: '2'
type: taxon
children:
data:
- id: '50'
type: menu_item
- id: '51'
type: menu_item
- id: '52'
type: menu_item
- id: '53'
type: menu_item
- id: '53'
type: menu_item
attributes:
code: null
name: Jackets and Coats
subtitle: null
link: /t/categories/men/jackets-and-coats
destination: null
item_type: Link
new_window: false
lft: 81
rgt: 82
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '42'
type: menu_item
linked_resource:
data:
id: '8'
type: taxon
children:
data: []
- id: '54'
type: menu_item
attributes:
code: null
name: Tops
subtitle: null
link: /t/categories/sportswear/tops
destination: null
item_type: Link
new_window: false
lft: 85
rgt: 86
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '43'
type: menu_item
linked_resource:
data:
id: '15'
type: taxon
children:
data: []
- id: '56'
type: menu_item
attributes:
code: null
name: Pants
subtitle: null
link: /t/categories/sportswear/pants
destination: null
item_type: Link
new_window: false
lft: 89
rgt: 90
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '43'
type: menu_item
linked_resource:
data:
id: '17'
type: taxon
children:
data: []
- id: '55'
type: menu_item
attributes:
code: null
name: Sweatshirts
subtitle: null
link: /t/categories/sportswear/sweatshirts
destination: null
item_type: Link
new_window: false
lft: 87
rgt: 88
depth: 2
is_container: false
is_root: false
is_child: true
is_leaf: true
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '43'
type: menu_item
linked_resource:
data:
id: '16'
type: taxon
children:
data: []
- id: '43'
type: menu_item
attributes:
code: null
name: Sportswear
subtitle: null
link: /t/categories/sportswear
destination: null
item_type: Link
new_window: false
lft: 84
rgt: 91
depth: 1
is_container: false
is_root: false
is_child: true
is_leaf: false
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data:
id: '2'
type: menu_item
linked_resource:
data:
id: '4'
type: taxon
children:
data:
- id: '54'
type: menu_item
- id: '55'
type: menu_item
- id: '56'
type: menu_item
- id: '2'
type: menu_item
attributes:
code: null
name: Footer Menu
subtitle: null
link: null
destination: null
item_type: Container
new_window: false
lft: 59
rgt: 92
depth: 0
is_container: true
is_root: true
is_child: false
is_leaf: false
relationships:
icon:
data: null
menu:
data:
id: '2'
type: menu
parent:
data: null
linked_resource:
data: null
children:
data:
- id: '41'
type: menu_item
- id: '42'
type: menu_item
- id: '43'
type: menu_item
MenuList:
description: 200 Success - Returns an array of `menu` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Menu'
included:
type: array
items:
$ref: '#/components/schemas/MenuIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
List of Menus:
value:
data:
- id: '1'
type: menu
attributes:
name: Main Menu
location: header
locale: en
relationships:
menu_items:
data:
- id: '13'
type: menu_item
- id: '19'
type: menu_item
- id: '17'
type: menu_item
- id: '21'
type: menu_item
- id: '18'
type: menu_item
- id: '29'
type: menu_item
- id: '28'
type: menu_item
- id: '35'
type: menu_item
- id: '32'
type: menu_item
- id: '31'
type: menu_item
- id: '34'
type: menu_item
- id: '30'
type: menu_item
- id: '33'
type: menu_item
- id: '16'
type: menu_item
- id: '22'
type: menu_item
- id: '23'
type: menu_item
- id: '38'
type: menu_item
- id: '37'
type: menu_item
- id: '36'
type: menu_item
- id: '24'
type: menu_item
- id: '25'
type: menu_item
- id: '20'
type: menu_item
- id: '14'
type: menu_item
- id: '40'
type: menu_item
- id: '39'
type: menu_item
- id: '27'
type: menu_item
- id: '26'
type: menu_item
- id: '1'
type: menu_item
- id: '15'
type: menu_item
- id: '2'
type: menu
attributes:
name: Footer Menu
location: footer
locale: en
relationships:
menu_items:
data:
- id: '46'
type: menu_item
- id: '45'
type: menu_item
- id: '44'
type: menu_item
- id: '47'
type: menu_item
- id: '48'
type: menu_item
- id: '41'
type: menu_item
- id: '49'
type: menu_item
- id: '50'
type: menu_item
- id: '51'
type: menu_item
- id: '52'
type: menu_item
- id: '42'
type: menu_item
- id: '53'
type: menu_item
- id: '54'
type: menu_item
- id: '56'
type: menu_item
- id: '55'
type: menu_item
- id: '43'
type: menu_item
- id: '2'
type: menu_item
meta:
count: 2
total_count: 2
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/menus'
next: 'http://localhost:3000/api/v2/storefront/menus?page=1'
prev: 'http://localhost:3000/api/v2/storefront/menus?page=1'
last: 'http://localhost:3000/api/v2/storefront/menus?page=1'
first: 'http://localhost:3000/api/v2/storefront/menus?page=1'
Wishlist:
description: 200 Success - Returns the `wishlist` object.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Wishlist'
included:
type: array
items:
$ref: '#/components/schemas/WishlistIncludes'
required:
- data
examples:
Wishlist:
value:
data:
id: '28'
type: wishlist
attributes:
token: 1inBHcJnxBrVEMAZb9esRqZP
name: My Wishlist
is_private: false
is_default: true
variant_included: false
relationships:
wished_items:
data:
- id: '14'
type: wished_item
Wishlist including Wished Items:
value:
data:
id: '28'
type: wishlist
attributes:
token: 1inBHcJnxBrVEMAZb9esRqZP
name: My Wishlist
is_private: false
is_default: true
variant_included: false
relationships:
wished_items:
data:
- id: '14'
type: wished_item
included:
- id: '14'
type: wished_item
attributes:
quantity: 7
price: '26.99'
total: '188.93'
display_price: $26.99
display_total: $188.93
relationships:
variant:
data:
id: '149'
type: variant
wishlist:
data:
id: '28'
type: wishlist
WishlistList:
description: 200 Success - Returns an array of `wishlist` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Wishlist'
included:
type: array
items:
$ref: '#/components/schemas/WishlistIncludes'
meta:
$ref: '#/components/schemas/ListMeta'
links:
$ref: '#/components/schemas/ListLinks'
required:
- data
- meta
- links
examples:
List of Wishlist's:
value:
data:
- id: '4'
type: wishlist
attributes:
token: gD1QP6SybtooojnxtkXPvcvh
name: My Wishlist
is_private: false
is_default: false
variant_included: true
relationships:
wished_items:
data:
- id: '4'
type: wished_item
- id: '5'
type: wished_item
- id: '8'
type: wishlist
attributes:
token: LKWCxupq2gsN9DRhwuNBCrf5
name: Fathers Day
is_private: true
is_default: true
variant_included: false
relationships:
wished_items:
data:
- id: '6'
type: wished_item
- id: '7'
type: wishlist
attributes:
token: QHnjcCvz21Dtzc6isWyiyBxM
name: Black Friday
is_private: false
is_default: false
variant_included: false
relationships:
wished_items:
data: []
meta:
count: 3
total_count: 3
total_pages: 1
links:
self: 'http://localhost:3000/api/v2/storefront/wishlists?is_variant_included=150'
next: 'http://localhost:3000/api/v2/storefront/wishlists?page=1'
prev: 'http://localhost:3000/api/v2/storefront/wishlists?page=1'
last: 'http://localhost:3000/api/v2/storefront/wishlists?page=1'
first: 'http://localhost:3000/api/v2/storefront/wishlists?page=1'
WishedItem:
description: 200 Success - Returns an array of `wished_item` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/WishedItem'
included:
type: array
items:
$ref: '#/components/schemas/WishedItemIncludes'
required:
- data
examples:
Wished Item:
value:
data:
id: '1'
type: wished_item
attributes:
quantity: 3
price: '55.99'
total: '167.97'
display_price: $55.99
display_total: $167.97
relationships:
variant:
data:
id: '149'
type: variant
Wished Item including Variant:
value:
data:
id: '2'
type: wished_item
attributes:
quantity: 3
price: '52.99'
total: '158.97'
display_price: $52.99
display_total: $158.97
relationships:
variant:
data:
id: '150'
type: variant
included:
- id: '150'
type: variant
attributes:
sku: JacketsandCoats_wool-blendcoat_52.99_beige_xs
weight: '0.0'
height: null
width: null
depth: null
is_master: false
options_text: 'Color: beige, Size: XS'
purchasable: true
in_stock: true
backorderable: false
currency: USD
price: '52.99'
display_price: $52.99
compare_at_price: null
display_compare_at_price: null
relationships:
product:
data:
id: '34'
type: product
images:
data: []
option_values:
data:
- id: '10'
type: option_value
- id: '23'
type: option_value
PaymentMethodList:
description: 200 Success - Returns an array of `payment_method` objects.
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentMethod'
required:
- data
examples:
List of Payment Methods:
value:
data:
- id: '1'
type: payment_method
attributes:
type: 'Spree::Gateway::Bogus'
name: Credit Card
description: Bogus payment gateway.
preferences:
dummy_key: PUBLICKEY123
- id: '2'
type: payment_method
attributes:
type: 'Spree::PaymentMethod::Check'
name: Check
description: Pay by check.
preferences: {}
tags:
- name: Account
- name: Account / Address
- name: Account / Credit Cards
- name: Account / Orders
- name: Cart
- name: Cart / Line Items
- name: Cart / Coupons
- name: Cart / Other
- name: Checkout
- name: Checkout / State
- name: Checkout / Shipments
- name: Checkout / Payments
- name: Checkout / Store Credit
- name: CMS Pages
- name: Countries
- name: Digital Downloads
- name: Menus
- name: Order Status
- name: Products
- name: Stores
- name: Taxons
- name: Wishlists
- name: Wishlists / Wished Items