Orders

Fluid Company APIs (1.0)

The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.

For APIs that authenticate with User tokens, see the Rep APIs documentation.

Download OpenAPI description
company.api.json
company.api.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/company.api/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Activities

Operations

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Resources

Operations

Application Theme Templates

Operations

Application Themes

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Conversations

Operations

Countries

Operations

Currencies

Operations

Customer Notes

Operations

Customer Orders

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default MySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

Events

Operations

FairShare Order Journey

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

Global Embeds

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Messages

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

List Commerce Orders

Request

List all commerce orders

Query
page[cursor]string

Cursor for pagination

page[limit]integer

Number of orders per page (max 100)

Example: page[limit]=25
start_datestring

Start date

Example: start_date=2025-01-01
end_datestring

End date

Example: end_date=2025-01-31
customer_idinteger

Customer ID

Example: customer_id=123
user_company_idinteger

User company ID

Example: user_company_id=456
searchstring

Search keyword

Example: search=john doe
within_daysinteger

Limit results to within the last N days

Example: within_days=30
subscription_idinteger

Subscription ID

Example: subscription_id=123
statusstring

Status filter

Enum"all""draft""awaiting_shipment""awaiting_payment""archived""cancelled"
Example: status=awaiting_shipment
typestring

Type of Order

Enum"sample_order""customer_order""member_order""enrollment_order""autoship_order"
Example: type=autoship
cart_sourcestring

Cart source

Enum"web""mobile""external""admin"
Example: cart_source=store_type
country_isosstring

Country ISOs

Example: country_isos=US,CA
sortstring

Sort orders by specified field. Prefix with - for descending. Available options: created_at, -created_at, id, -id, status, -status, customer, -customer, amount, -amount, no_of_quantities, -no_of_quantities

Example: sort=-created_at
force_statsboolean

Force stats calculation for large datasets

Example: force_stats=true
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/orders?cart_source=web&country_isos=string&customer_id=0&end_date=string&force_stats=true&page%5Bcursor%5D=string&page%5Blimit%5D=0&search=string&sort=string&start_date=string&status=all&subscription_id=0&type=sample_order&user_company_id=0&within_days=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
ordersArray of objectsrequired
orders[].​idinteger
Example: 1
orders[].​external_idstring or null
Example: "EXT-12345"
orders[].​amountstring
Example: "0.0"
orders[].​amount_in_basestring
Example: "10.0"
orders[].​base_to_currency_ratestring or null
Example: "1.35"
orders[].​shipping_in_basestring or null
Example: "7.99"
orders[].​tax_in_basestring or null
Example: "12.79"
orders[].​subtotal_in_basestring or null
Example: "139.21"
orders[].​enrollment_fee_in_basestring or null
Example: "0.0"
orders[].​discount_in_basestring or null
Example: "0.0"
orders[].​total_display_amountstring

Formatted amount with currency symbol

Example: "$100.50"
orders[].​total_cvinteger

Total Commission Volume for the order

Example: 25
orders[].​total_qvinteger

Total Qualifying Volume for the order

Example: 30
orders[].​bill_toobject
orders[].​billing_addressobject or null
orders[].​created_atstring
Example: "2025-04-25T08:54:27Z"
orders[].​currency_codestring
Example: "USD"
orders[].​split_paymentobject or null
orders[].​points_appliedinteger

Total points used for this order

Example: 500
orders[].​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
orders[].​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
orders[].​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
orders[].​free_shippingboolean

Whether the order has free shipping

Example: false
orders[].​customerobject
orders[].​emailstring or null
Example: "john.doe1@fluid.app"
orders[].​first_namestring or null
Example: "Morgan"
orders[].​itemsArray of objects
orders[].​last_namestring or null
Example: "Olson"
orders[].​notestring or null
Example: "Order notes"
orders[].​order_numberstring
Example: "1001"
orders[].​ship_toobject
orders[].​shipping_addressobject or null
orders[].​shippingstring
Example: "0.0"
orders[].​statusstring
Example: "awaiting_payment"
orders[].​fulfillment_statusstring
Example: "fulfilled"
orders[].​order_statusstring
Example: "Completed"
orders[].​financial_statusstring
Example: "Paid"
orders[].​taxstring
Example: "0.0"
orders[].​tokenstring
Example: "fo_5gczy7wuboaugpn0hemvec"
orders[].​currency_symbolstring
Example: "$"
orders[].​items_countinteger
Example: 10
orders[].​quantity_countinteger
Example: 10
orders[].​updated_atstring
Example: "2025-04-25T08:54:27Z"
orders[].​warehouse_idinteger or null
Example: 1
orders[].​order_on_behalf_ofboolean
Example: false
orders[].​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
orders[].​subscriptionobject or null
orders[].​subscriptionsArray of objects
metaobjectrequired
meta.​request_idstring
Example: "5d72c7cd-54c5-449d-93f5-6da4631cd267"
meta.​timestampstring
Example: "2025-04-25T09:13:38Z"
meta.​paginationobject
meta.​average_cvnumber
Example: 20
meta.​total_cvnumber
Example: 60
meta.​average_amount_basenumber
Example: 200
meta.​total_amount_basenumber
Example: 600
meta.​fulfilled_orders_countinteger
Example: 2
meta.​property name*anyadditional property
property name*anyadditional property
Response
application/json
{
  "orders": [
    { … }
  ],
  "meta": {
    "request_id": "5d72c7cd-54c5-449d-93f5-6da4631cd267",
    "timestamp": "2025-04-25T09:13:38Z",
    "pagination": { … },
    "average_cv": 20,
    "total_cv": 60,
    "average_amount_base": 200,
    "total_amount_base": 600,
    "fulfilled_orders_count": 2
  }
}

Retrieve Commerce Order

Request

Retrieve a commerce order

Path
idintegerrequired

Order ID

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
orderobjectrequired
order.​idinteger
Example: 1
order.​external_idstring or null
Example: "EXT-12345"
order.​amountstring
Example: "0.0"
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​shipping_in_basestring or null
Example: "7.99"
order.​tax_in_basestring or null
Example: "12.79"
order.​subtotal_in_basestring or null
Example: "139.21"
order.​enrollment_fee_in_basestring or null
Example: "0.0"
order.​discount_in_basestring or null
Example: "0.0"
order.​total_display_amountstring

Formatted amount with currency symbol

Example: "$100.50"
order.​total_cvinteger

Total Commission Volume for the order

Example: 25
order.​total_qvinteger

Total Qualifying Volume for the order

Example: 30
order.​bill_toobject
order.​billing_addressobject or null
order.​created_atstring
Example: "2025-04-25T08:54:27Z"
order.​currency_codestring
Example: "USD"
order.​split_paymentobject or null
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​customerobject(Customer)
order.​emailstring or null
Example: "john.doe1@fluid.app"
order.​first_namestring or null
Example: "Morgan"
order.​itemsArray of objects
order.​last_namestring or null
Example: "Olson"
order.​notestring or null
Example: "Order notes"
order.​order_numberstring
Example: "1001"
order.​ship_toobject
order.​shipping_addressobject or null
order.​shippingstring
Example: "0.0"
order.​statusstring
Example: "awaiting_payment"
order.​fulfillment_statusstring
Example: "Unfulfilled"
order.​order_statusstring
Example: "Completed"
order.​financial_statusstring
Example: "Paid"
order.​taxstring
Example: "0.0"
order.​tokenstring
Example: "fo_5gczy7wuboaugpn0hemvec"
order.​currency_symbolstring
Example: "$"
order.​items_countinteger
Example: 10
order.​quantity_countinteger
Example: 10
order.​updated_atstring
Example: "2025-04-25T08:54:27Z"
order.​warehouse_idinteger or null
Example: 1
order.​order_on_behalf_ofboolean
Example: false
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​subscriptionobject or null
order.​subscriptionsArray of objects
order.​cart_tokenstring or null
Example: "ct_1doa7jhNm4rLXqmJ3dG1GV"
order.​subtotalstring
Example: "100.00"
order.​sub_total_in_currencystring
Example: "$100.00"
order.​tax_in_currencystring
Example: "$10.00"
order.​discountstring
Example: "5.00"
order.​discount_in_currencystring
Example: "$5.00"
order.​transaction_feestring
Example: "2.50"
order.​enrollment_feestring
Example: "0.00"
order.​warehouse_namestring or null
Example: "Main Warehouse"
order.​payment_statusstring
Example: "pending"
order.​payment_methodobject or null
order.​metadataobject or null
order.​is_cancellableboolean
Example: true
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
order.​repobject or null
order.​refundsArray of objects(Refund)
order.​metafieldsArray of objects(LegacyMetafield)
metaobjectrequired
meta.​request_idstring
Example: "f5473a8c-8a86-4e0e-b3e8-95392003921b"
meta.​timestampstring
Example: "2024-12-10T08:04:10Z"
meta.​shop_urlstring
Example: "https://example.com"
Response
application/json
{
  "order": {
    "id": 1,
    "external_id": "EXT-12345",
    "amount": "0.0",
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "shipping_in_base": "7.99",
    "tax_in_base": "12.79",
    "subtotal_in_base": "139.21",
    "enrollment_fee_in_base": "0.0",
    "discount_in_base": "0.0",
    "total_display_amount": "$100.50",
    "total_cv": 25,
    "total_qv": 30,
    "bill_to": { … },
    "billing_address": { … },
    "created_at": "2025-04-25T08:54:27Z",
    "currency_code": "USD",
    "split_payment": { … },
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "discount_codes": [ … ],
    "free_shipping": false,
    "customer": { … },
    "email": "john.doe1@fluid.app",
    "first_name": "Morgan",
    "items": [ … ],
    "last_name": "Olson",
    "note": "Order notes",
    "order_number": "1001",
    "ship_to": { … },
    "shipping_address": { … },
    "shipping": "0.0",
    "status": "awaiting_payment",
    "fulfillment_status": "Unfulfilled",
    "order_status": "Completed",
    "financial_status": "Paid",
    "tax": "0.0",
    "token": "fo_5gczy7wuboaugpn0hemvec",
    "currency_symbol": "$",
    "items_count": 10,
    "quantity_count": 10,
    "updated_at": "2025-04-25T08:54:27Z",
    "warehouse_id": 1,
    "order_on_behalf_of": false,
    "source": "web",
    "subscription": { … },
    "subscriptions": [ … ],
    "cart_token": "ct_1doa7jhNm4rLXqmJ3dG1GV",
    "subtotal": "100.00",
    "sub_total_in_currency": "$100.00",
    "tax_in_currency": "$10.00",
    "discount": "5.00",
    "discount_in_currency": "$5.00",
    "transaction_fee": "2.50",
    "enrollment_fee": "0.00",
    "warehouse_name": "Main Warehouse",
    "payment_status": "pending",
    "payment_method": { … },
    "metadata": {},
    "is_cancellable": true,
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null,
    "rep": {},
    "refunds": [ … ],
    "metafields": [ … ]
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z",
    "shop_url": "https://example.com"
  }
}

Create Order

Request

Create an order from cart

Query
cart_tokenstringrequired

Token of the cart to create order from

Bodyapplication/json
orderobject
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/orders?cart_token=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "email": "customer@example.com",
      "status": "draft",
      "payment_status": "marked_paid/free",
      "order_type": "requested",
      "financial_status": "free",
      "order_status": "completed",
      "fulfillment_status": "fulfilled",
      "note": "Customer requested expedited shipping",
      "metafields": [
        {
          "namespace": "string",
          "key": "string",
          "value": null,
          "value_type": "single_line_text_field"
        }
      ]
    }
  }'

Responses

successful

Bodyapplication/json
orderobjectrequired
order.​idintegerrequired
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​currency_symbolstringrequired
order.​currency_codestring
order.​external_idstring or null
order.​order_numberstring
order.​tokenstring
order.​notestring or null
order.​company_logo_urlstring or null
order.​created_atstring
order.​customerstring or null
order.​emailstring or null
order.​totalstringrequired
order.​total_in_currencystring
order.​subtotalstring
Example: "90.00"
order.​subtotal_after_discountsstring
Example: "87.00"
order.​sub_totalstring
Example: "90.00"
order.​sub_total_in_currencystring
Example: "$90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​transaction_feenumber or string
Example: "1.90"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​payment_statusstringrequired
order.​enrollment_tokenstring or null
order.​enrollment_packobject or null
order.​fulfillment_statusstringrequired
order.​order_statusstring
order.​financial_statusstring
order.​delivery_statusstringrequired
order.​delivery_methodstringrequired
order.​delivery_datestring or null
Example: "2023-07-29"
order.​channelstringrequired
order.​tagsstringrequired
order.​items_countintegerrequired
order.​quantity_countinteger
order.​itemsArray of objectsrequired
order.​items[].​idinteger
Example: 101
order.​items[].​pricenumber or string
Example: 43.41
order.​items[].​price_in_currencystring
Example: "$43.41"
order.​items[].​taxstring
Example: "2.99"
order.​items[].​tax_in_currencystring
Example: "$2.99"
order.​items[].​cvinteger
Example: 5
order.​items[].​cv_in_currencystring
Example: "$5.00"
order.​items[].​qvinteger
Example: 7
order.​items[].​qv_in_currencystring
Example: "$7.00"
order.​items[].​product_titlestring
Example: "Sample Product"
order.​items[].​variant_titlestring or null
Example: "Sample Variant"
order.​items[].​variant_imagestring or null
Example: "https://example.com/image.png"
order.​items[].​variant_idinteger
Example: 202
order.​items[].​quantityinteger
Example: 3
order.​items[].​titlestring
order.​items[].​totalnumber or string
order.​items[].​image_urlstring or null
order.​items[].​skustring or null
order.​items[].​display_pricestring
order.​items[].​display_totalstring
order.​items[].​refundable_amountnumber or string(float)
Example: 10.5
order.​items[].​enrollment_pack_idinteger or null
order.​items[].​display_to_customerboolean or null
Example: true
order.​items[].​bundled_itemsArray of objects
order.​items[].​ordered_variantArray of objects
order.​items[].​productobject
order.​items[].​variantobject
order.​activitiesArray of objects
order.​shipping_methodobject or object
One of:
order.​payment_detailsobject or nullrequired
order.​payment_details.​payment_typestring
order.​payment_details.​detailsobject
order.​primary_domain_hostnamestring or null
Example: "fluid.com"
order.​company_subdomainstring or null
Example: "myco"
order.​shipping_totalstring
Example: "0.0"
order.​shipping_total_for_displaystring
Example: "Free"
order.​ship_toobjectrequired
order.​ship_to.​idinteger
Example: 1
order.​ship_to.​namestring or null
Example: "John Doe"
order.​ship_to.​first_namestring or null
Example: "John"
order.​ship_to.​last_namestring or null
Example: "Doe"
order.​ship_to.​address1string
Example: "123 Main St"
order.​ship_to.​address2string or null
Example: "Apt 4B"
order.​ship_to.​address3string or null
Example: "Building 5"
order.​ship_to.​citystring
Example: "New York"
order.​ship_to.​statestring
Example: "NY"
order.​ship_to.​postal_codestring
Example: "10001"
order.​ship_to.​country_codestring

country_id takes precedence if both country_id and country_code provided.

Example: "US"
order.​ship_to.​subdivision_codestring or null
Example: "NY"
order.​ship_to.​defaultboolean
Example: true
order.​bill_toobject
order.​shipping_addressobject or null
order.​billing_addressobject or null
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​split_paymentobject or null
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
meta.​shop_urlstring
Response
application/json
{
  "order": {
    "id": 0,
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "currency_symbol": "string",
    "currency_code": "string",
    "external_id": "string",
    "order_number": "string",
    "token": "string",
    "note": "string",
    "company_logo_url": "string",
    "created_at": "string",
    "customer": "string",
    "email": "string",
    "total": "string",
    "total_in_currency": "string",
    "subtotal": "90.00",
    "subtotal_after_discounts": "87.00",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "transaction_fee": "1.90",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "warehouse_id": 1,
    "warehouse": { … },
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "refundable_amount": 10.5,
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "order_status": "string",
    "financial_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_count": 0,
    "quantity_count": 0,
    "items": [ … ],
    "activities": [ … ],
    "shipping_method": { … },
    "payment_details": { … },
    "primary_domain_hostname": "fluid.com",
    "company_subdomain": "myco",
    "shipping_total": "0.0",
    "shipping_total_for_display": "Free",
    "ship_to": { … },
    "bill_to": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "free_shipping": false,
    "discount_codes": [ … ],
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "split_payment": { … },
    "source": "web",
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

Transfer an order to a different customer

Request

Transfers an existing order to a different customer within the same company

Path
idintegerrequired

Order ID

Bodyapplication/json
customer_idintegerrequired

ID of the customer to transfer the order to

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/orders/{id}/transfer_customer' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer_id": 0
  }'

Responses

Order transferred with no address updates

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "amount": "string",
    "created_at": "string",
    "updated_at": "string",
    "currency_code": "string",
    "order_number": "string",
    "status": "string",
    "note": "string",
    "token": "string",
    "tax": "string",
    "shipping": "string",
    "source": "mobile",
    "items": [ … ],
    "bill_to": {},
    "ship_to": {},
    "customer": { … }
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string"
  }
}

Update an order

Request

Update an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobject
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "note": "Customer requested expedited shipping",
      "external_id": "EXT-12345",
      "metadata": {
        "source": "mobile_app",
        "campaign_id": "summer2024"
      },
      "metafields": [
        {
          "id": 0,
          "namespace": "string",
          "key": "string",
          "value": null,
          "value_type": "single_line_text_field",
          "_destroy": true
        }
      ]
    }
  }'

Responses

Order updated successfully

Bodyapplication/json
orderobjectrequired
order.​idintegerrequired
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​currency_symbolstringrequired
order.​currency_codestring
order.​external_idstring or null
order.​order_numberstring
order.​tokenstring
order.​notestring or null
order.​company_logo_urlstring or null
order.​created_atstring
order.​customerstring or null
order.​emailstring or null
order.​totalstringrequired
order.​total_in_currencystring
order.​subtotalstring
Example: "90.00"
order.​subtotal_after_discountsstring
Example: "87.00"
order.​sub_totalstring
Example: "90.00"
order.​sub_total_in_currencystring
Example: "$90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​transaction_feenumber or string
Example: "1.90"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​payment_statusstringrequired
order.​enrollment_tokenstring or null
order.​enrollment_packobject or null
order.​fulfillment_statusstringrequired
order.​order_statusstring
order.​financial_statusstring
order.​delivery_statusstringrequired
order.​delivery_methodstringrequired
order.​delivery_datestring or null
Example: "2023-07-29"
order.​channelstringrequired
order.​tagsstringrequired
order.​items_countintegerrequired
order.​quantity_countinteger
order.​itemsArray of objectsrequired
order.​items[].​idinteger
Example: 101
order.​items[].​pricenumber or string
Example: 43.41
order.​items[].​price_in_currencystring
Example: "$43.41"
order.​items[].​taxstring
Example: "2.99"
order.​items[].​tax_in_currencystring
Example: "$2.99"
order.​items[].​cvinteger
Example: 5
order.​items[].​cv_in_currencystring
Example: "$5.00"
order.​items[].​qvinteger
Example: 7
order.​items[].​qv_in_currencystring
Example: "$7.00"
order.​items[].​product_titlestring
Example: "Sample Product"
order.​items[].​variant_titlestring or null
Example: "Sample Variant"
order.​items[].​variant_imagestring or null
Example: "https://example.com/image.png"
order.​items[].​variant_idinteger
Example: 202
order.​items[].​quantityinteger
Example: 3
order.​items[].​titlestring
order.​items[].​totalnumber or string
order.​items[].​image_urlstring or null
order.​items[].​skustring or null
order.​items[].​display_pricestring
order.​items[].​display_totalstring
order.​items[].​refundable_amountnumber or string(float)
Example: 10.5
order.​items[].​enrollment_pack_idinteger or null
order.​items[].​display_to_customerboolean or null
Example: true
order.​items[].​bundled_itemsArray of objects
order.​items[].​ordered_variantArray of objects
order.​items[].​productobject
order.​items[].​variantobject
order.​activitiesArray of objects
order.​shipping_methodobject or object
One of:
order.​payment_detailsobject or nullrequired
order.​payment_details.​payment_typestring
order.​payment_details.​detailsobject
order.​primary_domain_hostnamestring or null
Example: "fluid.com"
order.​company_subdomainstring or null
Example: "myco"
order.​shipping_totalstring
Example: "0.0"
order.​shipping_total_for_displaystring
Example: "Free"
order.​ship_toobjectrequired
order.​ship_to.​idinteger
Example: 1
order.​ship_to.​namestring or null
Example: "John Doe"
order.​ship_to.​first_namestring or null
Example: "John"
order.​ship_to.​last_namestring or null
Example: "Doe"
order.​ship_to.​address1string
Example: "123 Main St"
order.​ship_to.​address2string or null
Example: "Apt 4B"
order.​ship_to.​address3string or null
Example: "Building 5"
order.​ship_to.​citystring
Example: "New York"
order.​ship_to.​statestring
Example: "NY"
order.​ship_to.​postal_codestring
Example: "10001"
order.​ship_to.​country_codestring

country_id takes precedence if both country_id and country_code provided.

Example: "US"
order.​ship_to.​subdivision_codestring or null
Example: "NY"
order.​ship_to.​defaultboolean
Example: true
order.​bill_toobject
order.​shipping_addressobject or null
order.​billing_addressobject or null
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​split_paymentobject or null
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
meta.​shop_urlstring
Response
application/json
{
  "order": {
    "id": 0,
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "currency_symbol": "string",
    "currency_code": "string",
    "external_id": "string",
    "order_number": "string",
    "token": "string",
    "note": "string",
    "company_logo_url": "string",
    "created_at": "string",
    "customer": "string",
    "email": "string",
    "total": "string",
    "total_in_currency": "string",
    "subtotal": "90.00",
    "subtotal_after_discounts": "87.00",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "transaction_fee": "1.90",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "warehouse_id": 1,
    "warehouse": { … },
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "refundable_amount": 10.5,
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "order_status": "string",
    "financial_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_count": 0,
    "quantity_count": 0,
    "items": [ … ],
    "activities": [ … ],
    "shipping_method": { … },
    "payment_details": { … },
    "primary_domain_hostname": "fluid.com",
    "company_subdomain": "myco",
    "shipping_total": "0.0",
    "shipping_total_for_display": "Free",
    "ship_to": { … },
    "bill_to": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "free_shipping": false,
    "discount_codes": [ … ],
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "split_payment": { … },
    "source": "web",
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

Update an order (PUT method)

Request

Update an order using PUT method

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "note": "Customer requested expedited shipping",
      "external_id": "EXT-12345",
      "metadata": {
        "source": "mobile_app",
        "campaign_id": "summer2024"
      }
    }
  }'

Responses

Order updated successfully

Bodyapplication/json
orderobject

Updated order object with associations

metaobject
Response
application/json
{
  "order": {},
  "meta": {
    "shop_url": "https://test-company.fluid.com",
    "request_id": "string",
    "timestamp": "string"
  }
}

Update Order Warehouse

Request

Update the warehouse for an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
warehouse_idintegerrequired

ID of the warehouse to assign to the order

Example: 123
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/orders/{id}/update_warehouse' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "warehouse_id": 123
  }'

Responses

Order warehouse updated successfully

Bodyapplication/json
orderobjectrequired
order.​idintegerrequired
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​currency_symbolstringrequired
order.​currency_codestring
order.​external_idstring or null
order.​order_numberstring
order.​tokenstring
order.​notestring or null
order.​company_logo_urlstring or null
order.​created_atstring
order.​customerstring or null
order.​emailstring or null
order.​totalstringrequired
order.​total_in_currencystring
order.​subtotalstring
Example: "90.00"
order.​subtotal_after_discountsstring
Example: "87.00"
order.​sub_totalstring
Example: "90.00"
order.​sub_total_in_currencystring
Example: "$90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​transaction_feenumber or string
Example: "1.90"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​payment_statusstringrequired
order.​enrollment_tokenstring or null
order.​enrollment_packobject or null
order.​fulfillment_statusstringrequired
order.​order_statusstring
order.​financial_statusstring
order.​delivery_statusstringrequired
order.​delivery_methodstringrequired
order.​delivery_datestring or null
Example: "2023-07-29"
order.​channelstringrequired
order.​tagsstringrequired
order.​items_countintegerrequired
order.​quantity_countinteger
order.​itemsArray of objectsrequired
order.​items[].​idinteger
Example: 101
order.​items[].​pricenumber or string
Example: 43.41
order.​items[].​price_in_currencystring
Example: "$43.41"
order.​items[].​taxstring
Example: "2.99"
order.​items[].​tax_in_currencystring
Example: "$2.99"
order.​items[].​cvinteger
Example: 5
order.​items[].​cv_in_currencystring
Example: "$5.00"
order.​items[].​qvinteger
Example: 7
order.​items[].​qv_in_currencystring
Example: "$7.00"
order.​items[].​product_titlestring
Example: "Sample Product"
order.​items[].​variant_titlestring or null
Example: "Sample Variant"
order.​items[].​variant_imagestring or null
Example: "https://example.com/image.png"
order.​items[].​variant_idinteger
Example: 202
order.​items[].​quantityinteger
Example: 3
order.​items[].​titlestring
order.​items[].​totalnumber or string
order.​items[].​image_urlstring or null
order.​items[].​skustring or null
order.​items[].​display_pricestring
order.​items[].​display_totalstring
order.​items[].​refundable_amountnumber or string(float)
Example: 10.5
order.​items[].​enrollment_pack_idinteger or null
order.​items[].​display_to_customerboolean or null
Example: true
order.​items[].​bundled_itemsArray of objects
order.​items[].​ordered_variantArray of objects
order.​items[].​productobject
order.​items[].​variantobject
order.​activitiesArray of objects
order.​shipping_methodobject or object
One of:
order.​payment_detailsobject or nullrequired
order.​payment_details.​payment_typestring
order.​payment_details.​detailsobject
order.​primary_domain_hostnamestring or null
Example: "fluid.com"
order.​company_subdomainstring or null
Example: "myco"
order.​shipping_totalstring
Example: "0.0"
order.​shipping_total_for_displaystring
Example: "Free"
order.​ship_toobjectrequired
order.​ship_to.​idinteger
Example: 1
order.​ship_to.​namestring or null
Example: "John Doe"
order.​ship_to.​first_namestring or null
Example: "John"
order.​ship_to.​last_namestring or null
Example: "Doe"
order.​ship_to.​address1string
Example: "123 Main St"
order.​ship_to.​address2string or null
Example: "Apt 4B"
order.​ship_to.​address3string or null
Example: "Building 5"
order.​ship_to.​citystring
Example: "New York"
order.​ship_to.​statestring
Example: "NY"
order.​ship_to.​postal_codestring
Example: "10001"
order.​ship_to.​country_codestring

country_id takes precedence if both country_id and country_code provided.

Example: "US"
order.​ship_to.​subdivision_codestring or null
Example: "NY"
order.​ship_to.​defaultboolean
Example: true
order.​bill_toobject
order.​shipping_addressobject or null
order.​billing_addressobject or null
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​split_paymentobject or null
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​price_inclusive_of_taxboolean
Example: false
order.​price_inclusive_tax_namestring or null
Example: null
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
meta.​shop_urlstring
Response
application/json
{
  "order": {
    "id": 0,
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "currency_symbol": "string",
    "currency_code": "string",
    "external_id": "string",
    "order_number": "string",
    "token": "string",
    "note": "string",
    "company_logo_url": "string",
    "created_at": "string",
    "customer": "string",
    "email": "string",
    "total": "string",
    "total_in_currency": "string",
    "subtotal": "90.00",
    "subtotal_after_discounts": "87.00",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "transaction_fee": "1.90",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "warehouse_id": 1,
    "warehouse": { … },
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "refundable_amount": 10.5,
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "order_status": "string",
    "financial_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_count": 0,
    "quantity_count": 0,
    "items": [ … ],
    "activities": [ … ],
    "shipping_method": { … },
    "payment_details": { … },
    "primary_domain_hostname": "fluid.com",
    "company_subdomain": "myco",
    "shipping_total": "0.0",
    "shipping_total_for_display": "Free",
    "ship_to": { … },
    "bill_to": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "free_shipping": false,
    "discount_codes": [ … ],
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "split_payment": { … },
    "source": "web",
    "price_inclusive_of_tax": false,
    "price_inclusive_tax_name": null
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

Export Commerce Orders to CSV

Request

Export orders to CSV file (async or sync)

Query
within_daysinteger

Limit results to within the last N days

Example: within_days=30
report_typestring

Type of report to generate

Enum"orders""shipping""subscription"
Example: report_type=orders
send_emailboolean

Send export result via email

asyncboolean

Process export asynchronously

Example: async=true
start_datestring

Start date for filtering orders (MM/DD/YYYY)

Example: start_date=01/01/2025
end_datestring

End date for filtering orders (MM/DD/YYYY)

Example: end_date=01/31/2025
statusstring

Filter by order status

Example: status=processing
countriesstring

Filter by country codes (comma-separated)

Example: countries=US,CA
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/orders/export_csv?async=true&countries=string&end_date=string&report_type=orders&send_email=true&start_date=string&status=string&within_days=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

sync export completed

Bodyapplication/json
job_idstring
Example: "12345abcde"
statusstring
Example: "processing"
metaobjectrequired
meta.​request_idstringrequired
Example: "5d72c7cd-54c5-449d-93f5-6da4631cd267"
meta.​timestampstringrequired
Example: "2025-04-25T09:13:38Z"
urlstringrequired
Example: "https://cdn.example.com/exports/orders_2025-01-15.csv"
Response
application/json
{
  "job_id": "12345abcde",
  "status": "processing",
  "meta": {
    "request_id": "5d72c7cd-54c5-449d-93f5-6da4631cd267",
    "timestamp": "2025-04-25T09:13:38Z"
  },
  "url": "https://cdn.example.com/exports/orders_2025-01-15.csv"
}

Find orders by email

Request

Query
emailstringrequired

Email to find orders by

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/orders/find_by_email?email=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

orders found by customer email

List Orders

Request

Get all orders with optional filters

Query
customer_idinteger

Filter orders by customer

user_company_idinteger

Filter orders by user company

unfulfilledboolean

Filter unfulfilled orders

unpaidboolean

Filter unpaid orders

search_querystring

Search by order id, number, email, phone, first name, last name, order number, external id, product title, product sku, contact first name, contact last name, customer id, customer first name, customer last name

within_daysinteger

Filter orders created within the last number of days

datestring

Filter orders by date range (format: MM/DD/YYYY-MM/DD/YYYY)

pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
by_metadatastring(json)

Search JSON meta data

Default "{}"
sorted_bystring

Sort orders by specified field and direction. Available sort fields: id, created_at, order_number, amount, country, buyer, product_title.

Sort field should be followed by '_{direction}'; eg. id_asc, amount_desc, etc.

Example: sorted_by=created_at_desc
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders?by_metadata={}&customer_id=0&date=string&page=1&per_page=10&search_query=string&sorted_by=string&unfulfilled=true&unpaid=true&user_company_id=0&within_days=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Stats remain consistent across pagination

Bodyapplication/json
ordersArray of objectsrequired
orders[].​idinteger
Example: 1
orders[].​order_numberstring
Example: "F1248177316463"
orders[].​currency_codestring
Example: "USD"
orders[].​currency_symbolstring
Example: "$"
orders[].​customer_idinteger
Example: 1
orders[].​customerstring
Example: "John Doe"
orders[].​channelstring
Example: "Channel 2"
orders[].​payment_statusstring
Example: "Paid"
orders[].​is_cancellableboolean
Example: true
orders[].​statusstring
Example: "awaiting_payment"
orders[].​fulfillment_statusstring
Example: "Fulfilled"
orders[].​financial_statusstring
Example: "Paid"
orders[].​order_statusstring
Example: "Completed"
orders[].​totalstring
Example: "100.00"
orders[].​total_in_currencystring
Example: "$100.00 USD"
orders[].​subtotalstring
Example: "90.00"
orders[].​sub_totalstring
Example: "90.00"
orders[].​sub_total_in_currencystring
Example: "90.00"
orders[].​taxstring
Example: "2.00"
orders[].​tax_in_currencystring
Example: "$2.00 USD"
orders[].​discountstring
Example: "3.00"
orders[].​discount_in_currencystring
Example: "$3.00 USD"
orders[].​shippingstring
Example: "11.00"
orders[].​shipping_discountnumber
Example: 10.45
orders[].​notestring or null
Example: "Order note"
orders[].​cvinteger
Example: 100
orders[].​qvinteger
Example: 100
orders[].​external_idstring or null
Example: "1234567890"
orders[].​cart_idstring or null
Example: 1
orders[].​cart_tokenstring or null
Example: "CART_TOKEN"
orders[].​metadataobject
Example: {"level":"gold","tags":["Tag1","Tag2"],"camapaign":{"id":1,"name":"Winter 2025"}}
orders[].​shipping_in_currencyobject or null
orders[].​buyerobject or null
Example: {"share_guid":"f6b4c9"}
orders[].​delivery_methodstring
Example: "Courier"
orders[].​delivery_statusstring
Example: "In Transit"
orders[].​delivery_datestring or null
Example: "2023-07-29"
orders[].​tagsstring
Example: "Tag 1"
orders[].​created_atstring
Example: "2023-07-24T10:00:00.000Z"
orders[].​items_countinteger
Example: 2
orders[].​enrollment_tokenstring or null
Example: "et_12ad8jjhuxhtv4qlmn6poz"
orders[].​enrollment_pack_idinteger or null
Example: 1
orders[].​repobject or null
Example: {"email":{"type":"string","example":"john.doe@example.com"},"name":{"type":"string","example":"John Doe"},"id":{"type":"integer","example":1},"image_url":{"type":"string","example":"https://example.com/image.png"},"external_id":{"type":"string","example":"1234567890"}}
orders[].​ship_toobject or null
orders[].​bill_toobject or null
orders[].​activitiesArray of objects
orders[].​itemsArray of objects
orders[].​metafields_collectionArray of objects
orders[].​companyobject
orders[].​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
metaobjectrequired
meta.​request_idstringrequired
Example: "84eadc2f-4e51-4e3f-9f96-e8d7ba35cea4"
meta.​timestampstringrequired
Example: "2025-05-07T08:25:35Z"
meta.​current_pageinteger
meta.​next_pageinteger or null
meta.​prev_pageinteger or null
meta.​total_pagesinteger
meta.​total_countintegerrequired
meta.​average_cvinteger or number
Example: 20
meta.​total_cvinteger or number
Example: 60
meta.​average_amount_baseinteger or number
Example: 200
meta.​total_amount_baseinteger or number
Example: 600
meta.​fulfilled_orders_countinteger
Example: 2
meta.​stats_calculatedboolean
Example: false
meta.​messagestring
Example: "Stats calculation skipped for large dataset"
Response
application/json
{
  "orders": [
    { … }
  ],
  "meta": {
    "request_id": "84eadc2f-4e51-4e3f-9f96-e8d7ba35cea4",
    "timestamp": "2025-05-07T08:25:35Z",
    "current_page": 0,
    "next_page": 0,
    "prev_page": 0,
    "total_pages": 0,
    "total_count": 0,
    "average_cv": 20,
    "total_cv": 60,
    "average_amount_base": 200,
    "total_amount_base": 600,
    "fulfilled_orders_count": 2,
    "stats_calculated": false,
    "message": "Stats calculation skipped for large dataset"
  }
}

Orders' stats

Request

Get statistics for orders

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/stats \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
total_ordersintegerrequired
Example: 10
total_cancelled_ordersintegerrequired
Example: 2
total_shipped_ordersintegerrequired
Example: 8
metaobjectrequired
meta.​request_idstring
Example: "f5473a8c-8a86-4e0e-b3e8-95392003921b"
meta.​timestampstring
Example: "2024-12-10T08:04:10Z"
Response
application/json
{
  "total_orders": 10,
  "total_cancelled_orders": 2,
  "total_shipped_orders": 8,
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Show Order

Request

Show Order Information

Path
idintegerrequired

Order ID

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "order_number": "F1248177316463",
    "currency_code": "USD",
    "currency_symbol": "$",
    "created_at": "2023-07-24T10:00:00.000Z",
    "customer": {},
    "fulfillment_status": "Fulfilled",
    "financial_status": "Paid",
    "order_status": "Completed",
    "payment_status": "Paid",
    "is_cancellable": true,
    "note": "Order notes",
    "notes": [ … ],
    "rep": { … },
    "company": { … },
    "refunds": [ … ],
    "activities": [ … ],
    "payment_method": { … },
    "total": "100.00",
    "total_in_currency": "$100.00 USD",
    "sub_total": "90.00",
    "subtotal": "90.00",
    "sub_total_in_currency": "$90.00 USD",
    "shipping": { … },
    "shipping_discount": 10.45,
    "items_count": 10,
    "metadata": { … },
    "metafields_collection": [ … ],
    "metafields": [ … ],
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "enrollment_fee": 3,
    "enrollment_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "buyer": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "items": [ … ],
    "discount_in_currency": "$10.00 USD",
    "tax_in_currency": "$8.00 USD",
    "cv": 100,
    "qv": 100,
    "status": "awaiting_payment",
    "external_id": "1234567890",
    "cart_id": 1,
    "cart_token": "CART_TOKEN",
    "source": "web"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Cancel an Order

Request

Cancel an order

Path
idstringrequired

Order ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/cancel' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order cancelled successfully"
  }
}

Charge an Order

Request

Charge an order. Order must be in awaiting_payment status

Path
idstringrequired

Order ID

curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/charge' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order charged successfully"
  }
}

Append metadata field

Request

Path
idintegerrequired

Orders's Id

Bodyapplication/json
metadataobjectrequired

A JSON object that can store any custom data structure. When provided, merges with existing metadata data.

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/append_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {}
  }'

Responses

success

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "order_number": "F1248177316463",
    "currency_code": "USD",
    "currency_symbol": "$",
    "created_at": "2023-07-24T10:00:00.000Z",
    "customer": {},
    "fulfillment_status": "Fulfilled",
    "financial_status": "Paid",
    "order_status": "Completed",
    "payment_status": "Paid",
    "is_cancellable": true,
    "note": "Order notes",
    "notes": [ … ],
    "rep": { … },
    "company": { … },
    "refunds": [ … ],
    "activities": [ … ],
    "payment_method": { … },
    "total": "100.00",
    "total_in_currency": "$100.00 USD",
    "sub_total": "90.00",
    "subtotal": "90.00",
    "sub_total_in_currency": "$90.00 USD",
    "shipping": { … },
    "shipping_discount": 10.45,
    "items_count": 10,
    "metadata": { … },
    "metafields_collection": [ … ],
    "metafields": [ … ],
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "enrollment_fee": 3,
    "enrollment_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "buyer": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "items": [ … ],
    "discount_in_currency": "$10.00 USD",
    "tax_in_currency": "$8.00 USD",
    "cv": 100,
    "qv": 100,
    "status": "awaiting_payment",
    "external_id": "1234567890",
    "cart_id": 1,
    "cart_token": "CART_TOKEN",
    "source": "web"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Remove metadata field(s)

Request

Path
idintegerrequired

Order ID

Bodyapplication/json
metadataArray of stringsrequired

Array of metadata keys to remove. Supports dot notation for nested keys.

Example: ["level","referred_by.user.id","location_ids"]
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/remove_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": [
      "level",
      "referred_by.user.id",
      "location_ids"
    ]
  }'

Responses

successful

Bodyapplication/json
orderobject
metaobject
Response
application/json
{
  "order": {
    "id": 0,
    "order_number": "F1248177316463",
    "currency_code": "USD",
    "currency_symbol": "$",
    "created_at": "2023-07-24T10:00:00.000Z",
    "customer": {},
    "fulfillment_status": "Fulfilled",
    "financial_status": "Paid",
    "order_status": "Completed",
    "payment_status": "Paid",
    "is_cancellable": true,
    "note": "Order notes",
    "notes": [ … ],
    "rep": { … },
    "company": { … },
    "refunds": [ … ],
    "activities": [ … ],
    "payment_method": { … },
    "total": "100.00",
    "total_in_currency": "$100.00 USD",
    "sub_total": "90.00",
    "subtotal": "90.00",
    "sub_total_in_currency": "$90.00 USD",
    "shipping": { … },
    "shipping_discount": 10.45,
    "items_count": 10,
    "metadata": { … },
    "metafields_collection": [ … ],
    "metafields": [ … ],
    "transaction_fee": 3,
    "transaction_fee_in_currency": "$3.00 USD",
    "enrollment_fee": 3,
    "enrollment_fee_in_currency": "$3.00 USD",
    "discount": "10.00",
    "tax": "8.00",
    "dynamic_charges": { … },
    "dynamic_charges_in_currency": { … },
    "buyer": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "items": [ … ],
    "discount_in_currency": "$10.00 USD",
    "tax_in_currency": "$8.00 USD",
    "cv": 100,
    "qv": 100,
    "status": "awaiting_payment",
    "external_id": "1234567890",
    "cart_id": 1,
    "cart_token": "CART_TOKEN",
    "source": "web"
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Update Order Sponsor

Request

Update the sponsor (user_company) of an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobjectrequired
order.​user_company_idintegerrequired

ID of the UserCompany (sponsor)

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/update_sponsor' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "user_company_id": 0
    }
  }'

Responses

successful

Response
application/json
{
  "status": "fail",
  "data": {
    "error": "Sponsor not found"
  }
}

Archive an Order

Request

Archive an order

Path
idintegerrequired

Order ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/archive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful - order archived

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order archived successfully"
  }
}

Unarchive an Order

Request

Unarchive an order

Path
idintegerrequired

Order ID

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/unarchive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful - order unarchived

Bodyapplication/json
statusstring
Example: "success"
dataobject
Response
application/json
{
  "status": "success",
  "data": {
    "message": "Order unarchived successfully"
  }
}

Update Order External ID

Request

Update the external_id of an order

Path
idintegerrequired

Order ID

Bodyapplication/jsonrequired
orderobjectrequired
order.​external_idstringrequired

External ID for the order

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/{id}/update_external_id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "external_id": "string"
    }
  }'

Responses

successful

Response
application/json
{
  "status": "fail",
  "data": {
    "error": "Order not found."
  }
}

Send order invoice email

Request

Send an order invoice email

Bodyapplication/json

Invoice email parameters

cart_tokenstringrequired
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/orders/send_invoice_email \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cart_token": "string"
  }'

Responses

success

Bodyapplication/json
cart_tokenstringrequired
Example: "ct_ABC123"
metaobject
Response
application/json
{
  "cart_token": "ct_ABC123",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Retrieve Company Orders

Request

Retrieves a list of all company orders with their associated details including order information, customer data, and tracking details.

Query
pageinteger

Page number for paginated results

limitinteger

Number of orders to return per page

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/orders.json?limit=0&page=0'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8Array [
idinteger(int32)required
order_numberstringrequired
amountstringrequired
shippingstringrequired
taxstringrequired
subtotalstringrequired
first_namestringrequired
last_namestringrequired
emailstringrequired
phonestringrequired
trackingstringrequired
cvinteger(int32)required
qvinteger(int32)required
statusstringrequired
order_typestringrequired
ratinginteger(int32)required
reviewstringrequired
referrerstringrequired
friendly_statusstringrequired
typestringrequired
created_atstringrequired
currency_codestringrequired
currency_symbolstringrequired
display_amountstringrequired
display_subtotalstringrequired
display_taxstringrequired
display_shippingstringrequired
display_refundsstringrequired
display_discountstringrequired
order_thumbnailstringrequired
sale_datestringrequired
recognized_ship_datestringrequired
refundablebooleanrequired
max_refundable_amountstringrequired
max_refundable_taxstringrequired
max_refundable_shippingstringrequired
max_refundable_product_pricestringrequired
display_enrollment_feestring
ship_toobject(ShipTo2)required
Example: {"id":980199006,"name":"Bishal Nepal","address1":"jhapa","address2":null,"address3":null,"city":"damak","state":"Province 1","postal_code":"mechi","country_code":null,"country":{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0,"default":false,"created_at":"2022-05-09T05:12:21.806Z","updated_at":"2022-05-09T05:12:21.806Z","geo_entity_id":28},"default":false}
ship_to.​idinteger(int32)required
Example: 980199006
ship_to.​namestringrequired
Example: "Bishal Nepal"
ship_to.​address1stringrequired
Example: "jhapa"
ship_to.​address2stringrequired
ship_to.​address3stringrequired
ship_to.​citystringrequired
Example: "damak"
ship_to.​statestringrequired
Example: "Province 1"
ship_to.​postal_codestringrequired
Example: "mechi"
ship_to.​country_codestringrequired
ship_to.​countryobject(Country6)required
Example: {"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0,"default":false,"created_at":"2022-05-09T05:12:21.806Z","updated_at":"2022-05-09T05:12:21.806Z","geo_entity_id":28}
ship_to.​country.​idinteger(int32)required
Example: 141
ship_to.​country.​iso_namestringrequired
Example: "NEPAL"
ship_to.​country.​isostringrequired
Example: "NP"
ship_to.​country.​iso3stringrequired
Example: "NPL"
ship_to.​country.​namestringrequired
Example: "Nepal"
ship_to.​country.​numcodeinteger(int32)required
Example: 524
ship_to.​country.​activebooleanrequired
Example: true
ship_to.​country.​currency_codestringrequired
Example: "NPR"
ship_to.​country.​currency_symbolstringrequired
Example: "Rs."
ship_to.​country.​separatorstringrequired
Example: "."
ship_to.​country.​delimiterstringrequired
Example: ","
ship_to.​country.​address3booleanrequired
ship_to.​country.​statebooleanrequired
Example: true
ship_to.​country.​passportbooleanrequired
ship_to.​country.​itnbooleanrequired
ship_to.​country.​tax_rateinteger(int32)required
ship_to.​country.​defaultbooleanrequired
ship_to.​country.​created_atstringrequired
Example: "2022-05-09T05:12:21.806Z"
ship_to.​country.​updated_atstringrequired
Example: "2022-05-09T05:12:21.806Z"
ship_to.​country.​geo_entity_idinteger(int32)required
Example: 28
ship_to.​defaultbooleanrequired
contactobject(Contact)required
Example: {"id":6557,"token":"h59g4H8EExXpmNYmhq4woiMh","first_name":"Bishal","last_name":"Nepal","avatar_url":null,"status":null,"email":"bnepal05579887@gmail.com","email2":null,"phone":null,"phone2":null,"phone_id":null,"address":null,"address2":null,"city":null,"state":null,"postal_code":null,"language_id":null,"country_id":null,"lead_type":null,"ip":null,"requested_at":null,"best_time":null,"time_zone":null,"reason":null,"income":null,"hours":null,"invest":null,"interest":null,"full_name":"Bishal Nepal"}
contact.​idinteger(int32)required
Example: 6557
contact.​tokenstringrequired
Example: "h59g4H8EExXpmNYmhq4woiMh"
contact.​first_namestringrequired
Example: "Bishal"
contact.​last_namestringrequired
Example: "Nepal"
contact.​avatar_urlstringrequired
contact.​statusstringrequired
contact.​emailstringrequired
Example: "bnepal05579887@gmail.com"
contact.​email2stringrequired
contact.​phonestringrequired
contact.​phone2stringrequired
contact.​phone_idstringrequired
contact.​addressstringrequired
contact.​address2stringrequired
contact.​citystringrequired
contact.​statestringrequired
contact.​postal_codestringrequired
contact.​language_idstringrequired
contact.​country_idstringrequired
contact.​lead_typestringrequired
contact.​ipstringrequired
contact.​requested_atstringrequired
contact.​best_timestringrequired
contact.​time_zonestringrequired
contact.​reasonstringrequired
contact.​incomestringrequired
contact.​hoursstringrequired
contact.​investstringrequired
contact.​intereststringrequired
contact.​full_namestringrequired
Example: "Bishal Nepal"
itemsArray of objects(Item)required
items[].​idinteger(int32)required
items[].​quantityinteger(int32)required
items[].​priceinteger or numberrequired
One of:
integer(int32)
items[].​ordered_variantstringrequired
items[].​skustringrequired
items[].​productobject(Product8)required
Example: {"id":2240,"active":true,"title":"sketch","description":{"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"},"stripped":"best selling sketch","price":"12740.0","display_price":"Rs.12,740.00 (NPR)","subscription_price":"12740.0","display_subscription_price":"Rs.12,740.00 (NPR)","wholesale_price":"0.0","display_wholesale_price":"Rs.0.00 (NPR)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"Rs.0.00 (NPR)","shipping":"5.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","sku":"sketch","country_code":"ar","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.12,740.00"],"price_range_formatted":"Rs.0.00 - Rs.12,740.00","unlimited_inventory":false,"default_variant":{"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true},"currency_symbol":"Rs.","currency_code":"NPR","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"images":[{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}],"countries":[{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}],"enrolls":[{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]}
items[].​product.​idinteger(int32)required
Example: 2240
items[].​product.​activebooleanrequired
Example: true
items[].​product.​titlestringrequired
Example: "sketch"
items[].​product.​descriptionobject(Description)required
Example: {"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"}
items[].​product.​description.​idinteger(int32)required
Example: 4836
items[].​product.​description.​namestringrequired
Example: "description"
items[].​product.​description.​bodystringrequired
Example: "<div>best selling sketch</div>"
items[].​product.​description.​record_typestringrequired
Example: "Product"
items[].​product.​description.​record_idinteger(int32)required
Example: 2240
items[].​product.​description.​created_atstringrequired
Example: "2023-02-02T03:48:16.810Z"
items[].​product.​description.​updated_atstringrequired
Example: "2023-02-02T03:48:16.810Z"
items[].​product.​strippedstringrequired
Example: "best selling sketch"
items[].​product.​pricestringrequired
Example: "12740.0"
items[].​product.​display_pricestringrequired
Example: "Rs.12,740.00 (NPR)"
items[].​product.​subscription_pricestringrequired
Example: "12740.0"
items[].​product.​display_subscription_pricestringrequired
Example: "Rs.12,740.00 (NPR)"
items[].​product.​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_pricestringrequired
Example: "Rs.0.00 (NPR)"
items[].​product.​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_subscription_pricestringrequired
Example: "Rs.0.00 (NPR)"
items[].​product.​shippingstringrequired
Example: "5.0"
items[].​product.​imageobject(Image3)required
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
items[].​product.​image.​ministringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​detailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​fullstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​skustringrequired
Example: "sketch"
items[].​product.​country_codestringrequired
Example: "ar"
items[].​product.​country_idstringrequired
items[].​product.​viewsinteger(int32)required
items[].​product.​leadsinteger(int32)required
items[].​product.​share_linkstringrequired
items[].​product.​commissionstringrequired
Example: "10.0"
items[].​product.​publicbooleanrequired
Example: true
items[].​product.​shopify_idstringrequired
items[].​product.​shopify_handlestringrequired
items[].​product.​in_stockbooleanrequired
Example: true
items[].​product.​vendorstringrequired
items[].​product.​price_rangeArray of stringsrequired
Example: ["Rs.0.00","Rs.12,740.00"]
items[].​product.​price_range_formattedstringrequired
Example: "Rs.0.00 - Rs.12,740.00"
items[].​product.​unlimited_inventorybooleanrequired
items[].​product.​default_variant(null or DefaultVariant (object)) or string or nullrequired
Example: {"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true}
One of:
One of:
null
items[].​product.​currency_symbolstringrequired
Example: "Rs."
items[].​product.​currency_codestringrequired
Example: "NPR"
items[].​product.​average_ratinginteger(int32)required
items[].​product.​option_valuesobjectrequired
Example: {}
items[].​product.​option_values.​property name*object or string or nulladditional property
One of:
items[].​product.​publish_to_retail_storebooleanrequired
Example: true
items[].​product.​publish_to_rep_storebooleanrequired
Example: true
items[].​product.​publish_to_share_tabbooleanrequired
Example: true
items[].​product.​imagesArray of Image4 (object) or stringsrequired
Example: [{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}]
One of:
items[].​product.​images[].​idinteger(int32)
Example: 2089
items[].​product.​images[].​imageobject(Image3)
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
items[].​product.​images[].​image_urlstring
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​positionstring
items[].​product.​images[].​shopify_idstring
items[].​product.​countriesArray of objects(Country7)required
Example: [{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
items[].​product.​countries[].​idinteger(int32)required
Example: 27
items[].​product.​countries[].​iso_namestringrequired
Example: "BOTSWANA"
items[].​product.​countries[].​isostringrequired
Example: "BW"
items[].​product.​countries[].​iso3stringrequired
Example: "BWA"
items[].​product.​countries[].​namestringrequired
Example: "Botswana"
items[].​product.​countries[].​numcodeinteger(int32)required
Example: 72
items[].​product.​countries[].​activebooleanrequired
Example: true
items[].​product.​countries[].​currency_codestringrequired
Example: "BWP"
items[].​product.​countries[].​currency_symbolstringrequired
Example: "P"
items[].​product.​countries[].​separatorstringrequired
Example: "."
items[].​product.​countries[].​delimiterstringrequired
Example: ","
items[].​product.​countries[].​address3booleanrequired
items[].​product.​countries[].​statebooleanrequired
Example: true
items[].​product.​countries[].​passportbooleanrequired
items[].​product.​countries[].​itnbooleanrequired
items[].​product.​countries[].​tax_rateinteger(int32)required
items[].​product.​variantsArray of objects(Variant7)required
Example: [{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}]
items[].​product.​variants[].​idinteger(int32)required
Example: 19630
items[].​product.​variants[].​titlestringrequired
items[].​product.​variants[].​image_urlstringrequired
items[].​product.​variants[].​buyablebooleanrequired
Example: true
items[].​product.​variants[].​option_value_idsArray of strings or integersrequired
Example: []
One of:
string
items[].​product.​variants[].​allow_subscriptionbooleanrequired
Example: true
items[].​product.​variants[].​variant_countriesArray of VariantCountries5 (object) or (VariantCountries51 (object) or VariantCountries5 (object))required
Example: [{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]
One of:
items[].​product.​variants[].​variant_countries[].​idinteger(int32)required
Example: 130789
items[].​product.​variants[].​variant_countries[].​pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​shippingstringrequired
Example: "500.0"
items[].​product.​variants[].​variant_countries[].​taxstringrequired
Example: "200.0"
items[].​product.​variants[].​variant_countries[].​currency_codestringrequired
Example: "ARS"
items[].​product.​variants[].​variant_countries[].​currency_symbolstringrequired
Example: "$"
items[].​product.​variants[].​variant_countries[].​display_pricestringrequired
Example: "$9,800.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​country_isostringrequired
Example: "AR"
items[].​product.​variants[].​variant_countries[].​subscription_pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​display_wholesale_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​display_wholesale_subscription_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​countryobject(Country8)required
Example: {"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}
items[].​product.​optionsArray of Option2 (object) or Option21 (object)required
Example: []
One of:
items[].​product.​options[].​idinteger(int32)
items[].​product.​options[].​titlestring
items[].​product.​options[].​positioninteger(int32)
items[].​product.​options[].​created_atstring
items[].​product.​options[].​updated_atstring
items[].​product.​options[].​presentationstring
items[].​product.​options[].​company_idinteger(int32)
items[].​product.​options[].​external_idstring
items[].​product.​promptsArray of stringsrequired
Example: []
items[].​product.​enroll_productsArray of EnrollProduct (object) or stringsrequired
Example: [{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}]
One of:
items[].​product.​enroll_products[].​idinteger(int32)
Example: 19
items[].​product.​enroll_products[].​product_idinteger(int32)
Example: 2240
items[].​product.​enroll_products[].​enroll_idinteger(int32)
Example: 2
items[].​product.​enroll_products[].​activeboolean
Example: true
items[].​product.​enroll_products[].​typestring
Example: "membership_product"
items[].​product.​enroll_products[].​created_atstring
Example: "2023-02-15T06:40:53.303Z"
items[].​product.​enroll_products[].​updated_atstring
Example: "2023-02-15T06:40:53.303Z"
items[].​product.​enrollsArray of Enroll (object) or stringsrequired
Example: [{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]
One of:
items[].​product.​enrolls[].​idinteger(int32)
Example: 2
items[].​product.​enrolls[].​integration_idstring
items[].​product.​enrolls[].​fieldsobject(Fields)
Example: {"dob":"Birthdate","full_name":"Name","government_id":"Government ID"}
items[].​product.​enrolls[].​member_feeinteger(int32)
Example: 25
items[].​product.​enrolls[].​member_fee_enabledboolean
Example: true
items[].​product.​enrolls[].​company_idinteger(int32)
Example: 980191019
items[].​product.​enrolls[].​created_atstring
Example: "2023-02-01T07:49:12.347Z"
items[].​product.​enrolls[].​updated_atstring
Example: "2023-02-01T07:54:36.961Z"
items[].​product.​enrolls[].​terms_and_conditions_urlstring
Example: "https://www.google.com/"
tracking_informationsArray of stringsrequired
]
Response
application/json; charset=utf-8
[
  {
    "id": 0,
    "order_number": "string",
    "amount": "string",
    "shipping": "string",
    "tax": "string",
    "subtotal": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "tracking": "string",
    "cv": 0,
    "qv": 0,
    "status": "string",
    "order_type": "string",
    "rating": 0,
    "review": "string",
    "referrer": "string",
    "friendly_status": "string",
    "type": "string",
    "created_at": "string",
    "currency_code": "string",
    "currency_symbol": "string",
    "display_amount": "string",
    "display_subtotal": "string",
    "display_tax": "string",
    "display_shipping": "string",
    "display_refunds": "string",
    "display_discount": "string",
    "order_thumbnail": "string",
    "sale_date": "string",
    "recognized_ship_date": "string",
    "refundable": true,
    "max_refundable_amount": "string",
    "max_refundable_tax": "string",
    "max_refundable_shipping": "string",
    "max_refundable_product_price": "string",
    "display_enrollment_fee": "string",
    "ship_to": { … },
    "contact": { … },
    "items": [ … ],
    "tracking_informations": [ … ]
  }
]

Create Company Order

Request

Creates a new order for a company with the specified order details including customer information, shipping address, items, and payment information.

Bodyapplication/jsonrequired
orderobject(Order)required
Example: {"order_number":"K5124124","customer_email":"gavin@hooli.com","customer_firstname":"Gavin","customer_lastname":"Belson","affiliate":{"email":"tingeym2@gmail.com"},"ship_to":{"address1":"506 W 1060 N","city":"American Fork","state":"UT","postal_code":"84003"},"items":[{"sku":"ABC1234","name":"SRQ","image_url":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","quantity":2,"unit_price":99.99}],"amount_paid":218.73}
order.​order_numberstringrequired
Example: "K5124124"
order.​customer_emailstringrequired
Example: "gavin@hooli.com"
order.​customer_firstnamestringrequired
Example: "Gavin"
order.​customer_lastnamestringrequired
Example: "Belson"
order.​affiliateobject(Affiliate3)required
Example: {"email":"tingeym2@gmail.com"}
order.​affiliate.​emailstringrequired
Example: "tingeym2@gmail.com"
order.​ship_toobject(ShipTo3)required
Example: {"address1":"506 W 1060 N","city":"American Fork","state":"UT","postal_code":"84003"}
order.​ship_to.​address1stringrequired
Example: "506 W 1060 N"
order.​ship_to.​citystringrequired
Example: "American Fork"
order.​ship_to.​statestringrequired
Example: "UT"
order.​ship_to.​postal_codestringrequired
Example: "84003"
order.​itemsArray of objects(Item1)required
Example: [{"sku":"ABC1234","name":"SRQ","image_url":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","quantity":2,"unit_price":99.99}]
order.​items[].​skustringrequired
Example: "ABC1234"
order.​items[].​namestringrequired
Example: "SRQ"
order.​items[].​image_urlstringrequired
Example: "https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png"
order.​items[].​quantityinteger(int32)required
Example: 2
order.​items[].​unit_pricenumberrequired
Example: 99.99
order.​amount_paidnumberrequired
Example: 218.73
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company/orders.json \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "order_number": "K5124124",
      "customer_email": "gavin@hooli.com",
      "customer_firstname": "Gavin",
      "customer_lastname": "Belson",
      "affiliate": {
        "email": "tingeym2@gmail.com"
      },
      "ship_to": {
        "address1": "506 W 1060 N",
        "city": "American Fork",
        "state": "UT",
        "postal_code": "84003"
      },
      "items": [
        {
          "sku": "ABC1234",
          "name": "SRQ",
          "image_url": "https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png",
          "quantity": 2,
          "unit_price": 99.99
        }
      ],
      "amount_paid": 218.73
    }
  }'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
Example: 10276
order_numberstringrequired
Example: "K5124124"
amountstringrequired
Example: "218.73"
shippingstringrequired
Example: "0.0"
taxstringrequired
Example: "0.0"
subtotalstringrequired
Example: "0.0"
first_namestringrequired
Example: "Gavin"
last_namestringrequired
Example: "Belson"
emailstringrequired
Example: "gavin@hooli.com"
phonestringrequired
trackingstringrequired
cvinteger(int32)required
qvinteger(int32)required
statusstringrequired
Example: "awaiting_shipment"
order_typestringrequired
Example: "imported"
ratinginteger(int32)required
Example: 1
reviewstringrequired
referrerstringrequired
Example: "Mike Tingey"
friendly_statusstringrequired
Example: "paid"
typestringrequired
created_atstringrequired
Example: "2023-12-19T11:52:57.474Z"
currency_codestringrequired
Example: "AFN"
currency_symbolstringrequired
Example: "؋"
display_amountstringrequired
Example: "؋218.73 (AFN)"
display_subtotalstringrequired
Example: "؋0.00 (AFN)"
display_taxstringrequired
Example: "؋0.00 (AFN)"
display_shippingstringrequired
Example: "؋0.00 (AFN)"
display_refundsstringrequired
Example: "(0 CV, 0 QV) -؋0.00 (AFN)"
display_discountstringrequired
Example: "؋0.00 (AFN)"
order_thumbnailstringrequired
Example: "https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png"
sale_datestringrequired
Example: "2023-12-19T11:52:57.474Z"
recognized_ship_datestringrequired
refundablebooleanrequired
max_refundable_amountstringrequired
Example: "218.73"
max_refundable_taxstringrequired
Example: "0.0"
max_refundable_shippingstringrequired
Example: "0.0"
max_refundable_product_pricestringrequired
Example: "0.0"
ship_toobject(ShipTo4)required
Example: {"id":980200545,"name":null,"address1":"506 W 1060 N","address2":null,"address3":null,"city":"American Fork","state":"UT","postal_code":"84003","country_code":null,"country":null,"default":false}
ship_to.​idinteger(int32)required
Example: 980200545
ship_to.​namestringrequired
ship_to.​address1stringrequired
Example: "506 W 1060 N"
ship_to.​address2stringrequired
ship_to.​address3stringrequired
ship_to.​citystringrequired
Example: "American Fork"
ship_to.​statestringrequired
Example: "UT"
ship_to.​postal_codestringrequired
Example: "84003"
ship_to.​country_codestringrequired
ship_to.​countrystringrequired
ship_to.​defaultbooleanrequired
bill_tostringrequired
contactobject(Contact1)required
Example: {"id":18105,"token":"H8HneojRWb3qhs6mkNsCmAv3","first_name":"Gavin","last_name":"Belson","avatar_url":null,"status":"new","email":"gavin@hooli.com","email2":null,"phone":null,"phone2":null,"phone_id":null,"address":null,"address2":null,"city":null,"state":null,"postal_code":null,"language_id":null,"country_id":null,"lead_type":null,"ip":null,"requested_at":null,"best_time":null,"time_zone":null,"reason":null,"income":null,"hours":null,"invest":null,"interest":null,"full_name":"Gavin Belson"}
contact.​idinteger(int32)required
Example: 18105
contact.​tokenstringrequired
Example: "H8HneojRWb3qhs6mkNsCmAv3"
contact.​first_namestringrequired
Example: "Gavin"
contact.​last_namestringrequired
Example: "Belson"
contact.​avatar_urlstringrequired
contact.​statusstringrequired
Example: "new"
contact.​emailstringrequired
Example: "gavin@hooli.com"
contact.​email2stringrequired
contact.​phonestringrequired
contact.​phone2stringrequired
contact.​phone_idstringrequired
contact.​addressstringrequired
contact.​address2stringrequired
contact.​citystringrequired
contact.​statestringrequired
contact.​postal_codestringrequired
contact.​language_idstringrequired
contact.​country_idstringrequired
contact.​lead_typestringrequired
contact.​ipstringrequired
contact.​requested_atstringrequired
contact.​best_timestringrequired
contact.​time_zonestringrequired
contact.​reasonstringrequired
contact.​incomestringrequired
contact.​hoursstringrequired
contact.​investstringrequired
contact.​intereststringrequired
contact.​full_namestringrequired
Example: "Gavin Belson"
itemsArray of objects(Item2)required
Example: [{"id":10622,"quantity":2,"price":99.99,"ordered_variant":"","sku":null,"product":{"id":6684,"active":false,"title":"SRQ","description":{"id":null,"name":"description","body":null,"record_type":"Product","record_id":6684,"created_at":null,"updated_at":null},"stripped":"","price":"99.99","display_price":"؋99.99 (AFN)","subscription_price":"99.99","display_subscription_price":"؋99.99 (AFN)","wholesale_price":"0.0","display_wholesale_price":"؋0.00 (AFN)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"؋0.00 (AFN)","shipping":"0.0","image":{"mini":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","detail":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","full":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png"},"image_url":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","sku":"ABC1234","country_code":"us","country_id":1,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["$99.99","$99.99"],"price_range_formatted":"$99.99","unlimited_inventory":false,"default_variant":{"id":27306,"product_id":6684,"shopify_id":null,"title":null,"sku":"ABC1234","position":15756,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2023-12-19T11:52:57.058Z","updated_at":"2023-12-19T11:52:57.058Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":null,"size":null,"physical":true,"unit_of_weight":null,"height":null,"width":null,"length":null,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":true,"active":true,"bar_code":null,"track_quantity":true,"keep_selling":false,"option_attrs":[],"allow_subscription":true},"currency_symbol":"؋","currency_code":"AFN","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"images":[],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":39,"iso_name":"CHAD","iso":"TD","iso3":"TCD","name":"Chad","numcode":148,"active":true,"currency_code":"XAF","currency_symbol":"CFA","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":131,"iso_name":"MICRONESIA, FEDERATED STATES OF","iso":"FM","iso3":"FSM","name":"Micronesia, Federated States of","numcode":583,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":148,"iso_name":"NIGERIA","iso":"NG","iso3":"NGA","name":"Nigeria","numcode":566,"active":true,"currency_code":"NGN","currency_symbol":"₦","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":179,"iso_name":"SENEGAL","iso":"SN","iso3":"SEN","name":"Senegal","numcode":686,"active":true,"currency_code":"XOF","currency_symbol":"Fr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":205,"iso_name":"TUNISIA","iso":"TN","iso3":"TUN","name":"Tunisia","numcode":788,"active":true,"currency_code":"TND","currency_symbol":"د.ت","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":5,"iso_name":"ANDORRA","iso":"AD","iso3":"AND","name":"Andorra","numcode":20,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":6,"iso_name":"ANGOLA","iso":"AO","iso3":"AGO","name":"Angola","numcode":24,"active":true,"currency_code":"AOA","currency_symbol":"Kz","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":7,"iso_name":"ANGUILLA","iso":"AI","iso3":"AIA","name":"Anguilla","numcode":660,"active":true,"currency_code":"XCD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":8,"iso_name":"ANTIGUA AND BARBUDA","iso":"AG","iso3":"ATG","name":"Antigua and Barbuda","numcode":28,"active":true,"currency_code":"XCD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":78,"iso_name":"GREENLAND","iso":"GL","iso3":"GRL","name":"Greenland","numcode":304,"active":true,"currency_code":"DKK","currency_symbol":"kr.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":35,"iso_name":"CANADA","iso":"CA","iso3":"CAN","name":"Canada","numcode":124,"active":true,"currency_code":"CAD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":142,"iso_name":"NETHERLANDS","iso":"NL","iso3":"NLD","name":"Netherlands","numcode":528,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":144,"iso_name":"NEW CALEDONIA","iso":"NC","iso3":"NCL","name":"New Caledonia","numcode":540,"active":true,"currency_code":"XPF","currency_symbol":"Fr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":192,"iso_name":"SVALBARD AND JAN MAYEN","iso":"SJ","iso3":"SJM","name":"Svalbard and Jan Mayen","numcode":744,"active":true,"currency_code":"NOK","currency_symbol":"kr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":224,"iso_name":"YEMEN","iso":"YE","iso3":"YEM","name":"Yemen","numcode":887,"active":true,"currency_code":"YER","currency_symbol":"﷼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":27306,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":3147116,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋99.99 (AFN)","country_iso":"AF","subscription_price":"99.99","display_wholesale_price":"؋0.00 (AFN)","display_wholesale_subscription_price":"؋0.00 (AFN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}},{"id":3147117,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ALL","currency_symbol":"L","display_price":"L99.99 (ALL)","country_iso":"AL","subscription_price":"99.99","display_wholesale_price":"L0.00 (ALL)","display_wholesale_subscription_price":"L0.00 (ALL)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":2,"iso":"AL","iso_name":"ALBANIA","iso3":"ALB","name":"Albania","tax_rate":0}},{"id":3147118,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DZD","currency_symbol":"د.ج","display_price":"د.ج99.99 (DZD)","country_iso":"DZ","subscription_price":"99.99","display_wholesale_price":"د.ج0.00 (DZD)","display_wholesale_subscription_price":"د.ج0.00 (DZD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":3,"iso":"DZ","iso_name":"ALGERIA","iso3":"DZA","name":"Algeria","tax_rate":0}},{"id":3147119,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AD","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":5,"iso":"AD","iso_name":"ANDORRA","iso3":"AND","name":"Andorra","tax_rate":0}},{"id":3147120,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AOA","currency_symbol":"Kz","display_price":"Kz99.99 (AOA)","country_iso":"AO","subscription_price":"99.99","display_wholesale_price":"Kz0.00 (AOA)","display_wholesale_subscription_price":"Kz0.00 (AOA)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":6,"iso":"AO","iso_name":"ANGOLA","iso3":"AGO","name":"Angola","tax_rate":0}},{"id":3147121,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AI","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":7,"iso":"AI","iso_name":"ANGUILLA","iso3":"AIA","name":"Anguilla","tax_rate":0}},{"id":3147122,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AG","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":8,"iso":"AG","iso_name":"ANTIGUA AND BARBUDA","iso3":"ATG","name":"Antigua and Barbuda","tax_rate":0}},{"id":3147123,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ARS","currency_symbol":"$","display_price":"$99.99 (ARS)","country_iso":"AR","subscription_price":"99.99","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":3147124,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AUD","currency_symbol":"$","display_price":"$99.99 (AUD)","country_iso":"AU","subscription_price":"99.99","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":3147125,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AT","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":3147126,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼99.99 (AZN)","country_iso":"AZ","subscription_price":"99.99","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":3147127,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BSD","currency_symbol":"$","display_price":"$99.99 (BSD)","country_iso":"BS","subscription_price":"99.99","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":3147128,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب99.990 (BHD)","country_iso":"BH","subscription_price":"99.99","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":3147129,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.99.99 (BTN)","country_iso":"BT","subscription_price":"99.99","display_wholesale_price":"Nu.0.00 (BTN)","display_wholesale_subscription_price":"Nu.0.00 (BTN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":3147130,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"CAD","currency_symbol":"$","display_price":"$99.99 (CAD)","country_iso":"CA","subscription_price":"99.99","display_wholesale_price":"$0.00 (CAD)","display_wholesale_subscription_price":"$0.00 (CAD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":35,"iso":"CA","iso_name":"CANADA","iso3":"CAN","name":"Canada","tax_rate":0}},{"id":3147131,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XAF","currency_symbol":"CFA","display_price":"CFA100 (XAF)","country_iso":"TD","subscription_price":"99.99","display_wholesale_price":"CFA0 (XAF)","display_wholesale_subscription_price":"CFA0 (XAF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":39,"iso":"TD","iso_name":"CHAD","iso3":"TCD","name":"Chad","tax_rate":0}},{"id":3147132,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"DE","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":74,"iso":"DE","iso_name":"GERMANY","iso3":"DEU","name":"Germany","tax_rate":0}},{"id":3147133,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DKK","currency_symbol":"kr.","display_price":"kr.99.99 (DKK)","country_iso":"GL","subscription_price":"99.99","display_wholesale_price":"kr.0.00 (DKK)","display_wholesale_subscription_price":"kr.0.00 (DKK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":78,"iso":"GL","iso_name":"GREENLAND","iso3":"GRL","name":"Greenland","tax_rate":0}},{"id":3147134,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"INR","currency_symbol":"₹","display_price":"₹99.99 (INR)","country_iso":"IN","subscription_price":"99.99","display_wholesale_price":"₹0.00 (INR)","display_wholesale_subscription_price":"₹0.00 (INR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":92,"iso":"IN","iso_name":"INDIA","iso3":"IND","name":"India","tax_rate":0}},{"id":3147135,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"FM","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":131,"iso":"FM","iso_name":"MICRONESIA, FEDERATED STATES OF","iso3":"FSM","name":"Micronesia, Federated States of","tax_rate":0}},{"id":3147136,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.99.99 (NPR)","country_iso":"NP","subscription_price":"99.99","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":3147137,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"NL","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":142,"iso":"NL","iso_name":"NETHERLANDS","iso3":"NLD","name":"Netherlands","tax_rate":0}},{"id":3147138,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XPF","currency_symbol":"Fr","display_price":"Fr100 (XPF)","country_iso":"NC","subscription_price":"99.99","display_wholesale_price":"Fr0 (XPF)","display_wholesale_subscription_price":"Fr0 (XPF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":144,"iso":"NC","iso_name":"NEW CALEDONIA","iso3":"NCL","name":"New Caledonia","tax_rate":0}},{"id":3147139,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NGN","currency_symbol":"₦","display_price":"₦99.99 (NGN)","country_iso":"NG","subscription_price":"99.99","display_wholesale_price":"₦0.00 (NGN)","display_wholesale_subscription_price":"₦0.00 (NGN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":148,"iso":"NG","iso_name":"NIGERIA","iso3":"NGA","name":"Nigeria","tax_rate":0}},{"id":3147140,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XOF","currency_symbol":"Fr","display_price":"Fr100 (XOF)","country_iso":"SN","subscription_price":"99.99","display_wholesale_price":"Fr0 (XOF)","display_wholesale_subscription_price":"Fr0 (XOF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":179,"iso":"SN","iso_name":"SENEGAL","iso3":"SEN","name":"Senegal","tax_rate":0}},{"id":3147141,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NOK","currency_symbol":"kr","display_price":"kr99.99 (NOK)","country_iso":"SJ","subscription_price":"99.99","display_wholesale_price":"kr0.00 (NOK)","display_wholesale_subscription_price":"kr0.00 (NOK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":192,"iso":"SJ","iso_name":"SVALBARD AND JAN MAYEN","iso3":"SJM","name":"Svalbard and Jan Mayen","tax_rate":0}},{"id":3147142,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"TND","currency_symbol":"د.ت","display_price":"د.ت99.990 (TND)","country_iso":"TN","subscription_price":"99.99","display_wholesale_price":"د.ت0.000 (TND)","display_wholesale_subscription_price":"د.ت0.000 (TND)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":205,"iso":"TN","iso_name":"TUNISIA","iso3":"TUN","name":"Tunisia","tax_rate":0}},{"id":3147143,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"US","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}},{"id":3147144,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"YER","currency_symbol":"﷼","display_price":"﷼99.99 (YER)","country_iso":"YE","subscription_price":"99.99","display_wholesale_price":"﷼0.00 (YER)","display_wholesale_subscription_price":"﷼0.00 (YER)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":224,"iso":"YE","iso_name":"YEMEN","iso3":"YEM","name":"Yemen","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrolls":[]}}]
items[].​idinteger(int32)required
Example: 10622
items[].​quantityinteger(int32)required
Example: 2
items[].​pricenumberrequired
Example: 99.99
items[].​ordered_variantstringrequired
items[].​skustringrequired
items[].​productobject(Product9)required
Example: {"id":6684,"active":false,"title":"SRQ","description":{"id":null,"name":"description","body":null,"record_type":"Product","record_id":6684,"created_at":null,"updated_at":null},"stripped":"","price":"99.99","display_price":"؋99.99 (AFN)","subscription_price":"99.99","display_subscription_price":"؋99.99 (AFN)","wholesale_price":"0.0","display_wholesale_price":"؋0.00 (AFN)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"؋0.00 (AFN)","shipping":"0.0","image":{"mini":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","detail":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","full":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png"},"image_url":"https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png","sku":"ABC1234","country_code":"us","country_id":1,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["$99.99","$99.99"],"price_range_formatted":"$99.99","unlimited_inventory":false,"default_variant":{"id":27306,"product_id":6684,"shopify_id":null,"title":null,"sku":"ABC1234","position":15756,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2023-12-19T11:52:57.058Z","updated_at":"2023-12-19T11:52:57.058Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":null,"size":null,"physical":true,"unit_of_weight":null,"height":null,"width":null,"length":null,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":true,"active":true,"bar_code":null,"track_quantity":true,"keep_selling":false,"option_attrs":[],"allow_subscription":true},"currency_symbol":"؋","currency_code":"AFN","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"images":[],"countries":[{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":39,"iso_name":"CHAD","iso":"TD","iso3":"TCD","name":"Chad","numcode":148,"active":true,"currency_code":"XAF","currency_symbol":"CFA","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":131,"iso_name":"MICRONESIA, FEDERATED STATES OF","iso":"FM","iso3":"FSM","name":"Micronesia, Federated States of","numcode":583,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":148,"iso_name":"NIGERIA","iso":"NG","iso3":"NGA","name":"Nigeria","numcode":566,"active":true,"currency_code":"NGN","currency_symbol":"₦","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":179,"iso_name":"SENEGAL","iso":"SN","iso3":"SEN","name":"Senegal","numcode":686,"active":true,"currency_code":"XOF","currency_symbol":"Fr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":205,"iso_name":"TUNISIA","iso":"TN","iso3":"TUN","name":"Tunisia","numcode":788,"active":true,"currency_code":"TND","currency_symbol":"د.ت","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":5,"iso_name":"ANDORRA","iso":"AD","iso3":"AND","name":"Andorra","numcode":20,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":6,"iso_name":"ANGOLA","iso":"AO","iso3":"AGO","name":"Angola","numcode":24,"active":true,"currency_code":"AOA","currency_symbol":"Kz","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":7,"iso_name":"ANGUILLA","iso":"AI","iso3":"AIA","name":"Anguilla","numcode":660,"active":true,"currency_code":"XCD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":8,"iso_name":"ANTIGUA AND BARBUDA","iso":"AG","iso3":"ATG","name":"Antigua and Barbuda","numcode":28,"active":true,"currency_code":"XCD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":78,"iso_name":"GREENLAND","iso":"GL","iso3":"GRL","name":"Greenland","numcode":304,"active":true,"currency_code":"DKK","currency_symbol":"kr.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":35,"iso_name":"CANADA","iso":"CA","iso3":"CAN","name":"Canada","numcode":124,"active":true,"currency_code":"CAD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":142,"iso_name":"NETHERLANDS","iso":"NL","iso3":"NLD","name":"Netherlands","numcode":528,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":144,"iso_name":"NEW CALEDONIA","iso":"NC","iso3":"NCL","name":"New Caledonia","numcode":540,"active":true,"currency_code":"XPF","currency_symbol":"Fr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":192,"iso_name":"SVALBARD AND JAN MAYEN","iso":"SJ","iso3":"SJM","name":"Svalbard and Jan Mayen","numcode":744,"active":true,"currency_code":"NOK","currency_symbol":"kr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":224,"iso_name":"YEMEN","iso":"YE","iso3":"YEM","name":"Yemen","numcode":887,"active":true,"currency_code":"YER","currency_symbol":"﷼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":27306,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":3147116,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋99.99 (AFN)","country_iso":"AF","subscription_price":"99.99","display_wholesale_price":"؋0.00 (AFN)","display_wholesale_subscription_price":"؋0.00 (AFN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}},{"id":3147117,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ALL","currency_symbol":"L","display_price":"L99.99 (ALL)","country_iso":"AL","subscription_price":"99.99","display_wholesale_price":"L0.00 (ALL)","display_wholesale_subscription_price":"L0.00 (ALL)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":2,"iso":"AL","iso_name":"ALBANIA","iso3":"ALB","name":"Albania","tax_rate":0}},{"id":3147118,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DZD","currency_symbol":"د.ج","display_price":"د.ج99.99 (DZD)","country_iso":"DZ","subscription_price":"99.99","display_wholesale_price":"د.ج0.00 (DZD)","display_wholesale_subscription_price":"د.ج0.00 (DZD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":3,"iso":"DZ","iso_name":"ALGERIA","iso3":"DZA","name":"Algeria","tax_rate":0}},{"id":3147119,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AD","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":5,"iso":"AD","iso_name":"ANDORRA","iso3":"AND","name":"Andorra","tax_rate":0}},{"id":3147120,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AOA","currency_symbol":"Kz","display_price":"Kz99.99 (AOA)","country_iso":"AO","subscription_price":"99.99","display_wholesale_price":"Kz0.00 (AOA)","display_wholesale_subscription_price":"Kz0.00 (AOA)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":6,"iso":"AO","iso_name":"ANGOLA","iso3":"AGO","name":"Angola","tax_rate":0}},{"id":3147121,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AI","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":7,"iso":"AI","iso_name":"ANGUILLA","iso3":"AIA","name":"Anguilla","tax_rate":0}},{"id":3147122,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AG","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":8,"iso":"AG","iso_name":"ANTIGUA AND BARBUDA","iso3":"ATG","name":"Antigua and Barbuda","tax_rate":0}},{"id":3147123,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ARS","currency_symbol":"$","display_price":"$99.99 (ARS)","country_iso":"AR","subscription_price":"99.99","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":3147124,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AUD","currency_symbol":"$","display_price":"$99.99 (AUD)","country_iso":"AU","subscription_price":"99.99","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":3147125,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AT","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":3147126,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼99.99 (AZN)","country_iso":"AZ","subscription_price":"99.99","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":3147127,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BSD","currency_symbol":"$","display_price":"$99.99 (BSD)","country_iso":"BS","subscription_price":"99.99","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":3147128,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب99.990 (BHD)","country_iso":"BH","subscription_price":"99.99","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":3147129,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.99.99 (BTN)","country_iso":"BT","subscription_price":"99.99","display_wholesale_price":"Nu.0.00 (BTN)","display_wholesale_subscription_price":"Nu.0.00 (BTN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":3147130,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"CAD","currency_symbol":"$","display_price":"$99.99 (CAD)","country_iso":"CA","subscription_price":"99.99","display_wholesale_price":"$0.00 (CAD)","display_wholesale_subscription_price":"$0.00 (CAD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":35,"iso":"CA","iso_name":"CANADA","iso3":"CAN","name":"Canada","tax_rate":0}},{"id":3147131,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XAF","currency_symbol":"CFA","display_price":"CFA100 (XAF)","country_iso":"TD","subscription_price":"99.99","display_wholesale_price":"CFA0 (XAF)","display_wholesale_subscription_price":"CFA0 (XAF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":39,"iso":"TD","iso_name":"CHAD","iso3":"TCD","name":"Chad","tax_rate":0}},{"id":3147132,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"DE","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":74,"iso":"DE","iso_name":"GERMANY","iso3":"DEU","name":"Germany","tax_rate":0}},{"id":3147133,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DKK","currency_symbol":"kr.","display_price":"kr.99.99 (DKK)","country_iso":"GL","subscription_price":"99.99","display_wholesale_price":"kr.0.00 (DKK)","display_wholesale_subscription_price":"kr.0.00 (DKK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":78,"iso":"GL","iso_name":"GREENLAND","iso3":"GRL","name":"Greenland","tax_rate":0}},{"id":3147134,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"INR","currency_symbol":"₹","display_price":"₹99.99 (INR)","country_iso":"IN","subscription_price":"99.99","display_wholesale_price":"₹0.00 (INR)","display_wholesale_subscription_price":"₹0.00 (INR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":92,"iso":"IN","iso_name":"INDIA","iso3":"IND","name":"India","tax_rate":0}},{"id":3147135,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"FM","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":131,"iso":"FM","iso_name":"MICRONESIA, FEDERATED STATES OF","iso3":"FSM","name":"Micronesia, Federated States of","tax_rate":0}},{"id":3147136,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.99.99 (NPR)","country_iso":"NP","subscription_price":"99.99","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":3147137,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"NL","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":142,"iso":"NL","iso_name":"NETHERLANDS","iso3":"NLD","name":"Netherlands","tax_rate":0}},{"id":3147138,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XPF","currency_symbol":"Fr","display_price":"Fr100 (XPF)","country_iso":"NC","subscription_price":"99.99","display_wholesale_price":"Fr0 (XPF)","display_wholesale_subscription_price":"Fr0 (XPF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":144,"iso":"NC","iso_name":"NEW CALEDONIA","iso3":"NCL","name":"New Caledonia","tax_rate":0}},{"id":3147139,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NGN","currency_symbol":"₦","display_price":"₦99.99 (NGN)","country_iso":"NG","subscription_price":"99.99","display_wholesale_price":"₦0.00 (NGN)","display_wholesale_subscription_price":"₦0.00 (NGN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":148,"iso":"NG","iso_name":"NIGERIA","iso3":"NGA","name":"Nigeria","tax_rate":0}},{"id":3147140,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XOF","currency_symbol":"Fr","display_price":"Fr100 (XOF)","country_iso":"SN","subscription_price":"99.99","display_wholesale_price":"Fr0 (XOF)","display_wholesale_subscription_price":"Fr0 (XOF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":179,"iso":"SN","iso_name":"SENEGAL","iso3":"SEN","name":"Senegal","tax_rate":0}},{"id":3147141,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NOK","currency_symbol":"kr","display_price":"kr99.99 (NOK)","country_iso":"SJ","subscription_price":"99.99","display_wholesale_price":"kr0.00 (NOK)","display_wholesale_subscription_price":"kr0.00 (NOK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":192,"iso":"SJ","iso_name":"SVALBARD AND JAN MAYEN","iso3":"SJM","name":"Svalbard and Jan Mayen","tax_rate":0}},{"id":3147142,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"TND","currency_symbol":"د.ت","display_price":"د.ت99.990 (TND)","country_iso":"TN","subscription_price":"99.99","display_wholesale_price":"د.ت0.000 (TND)","display_wholesale_subscription_price":"د.ت0.000 (TND)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":205,"iso":"TN","iso_name":"TUNISIA","iso3":"TUN","name":"Tunisia","tax_rate":0}},{"id":3147143,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"US","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}},{"id":3147144,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"YER","currency_symbol":"﷼","display_price":"﷼99.99 (YER)","country_iso":"YE","subscription_price":"99.99","display_wholesale_price":"﷼0.00 (YER)","display_wholesale_subscription_price":"﷼0.00 (YER)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":224,"iso":"YE","iso_name":"YEMEN","iso3":"YEM","name":"Yemen","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[],"enrolls":[]}
items[].​product.​idinteger(int32)required
Example: 6684
items[].​product.​activebooleanrequired
items[].​product.​titlestringrequired
Example: "SRQ"
items[].​product.​descriptionobject(Description1)required
Example: {"id":null,"name":"description","body":null,"record_type":"Product","record_id":6684,"created_at":null,"updated_at":null}
items[].​product.​description.​idstringrequired
items[].​product.​description.​namestringrequired
Example: "description"
items[].​product.​description.​bodystringrequired
items[].​product.​description.​record_typestringrequired
Example: "Product"
items[].​product.​description.​record_idinteger(int32)required
Example: 6684
items[].​product.​description.​created_atstringrequired
items[].​product.​description.​updated_atstringrequired
items[].​product.​strippedstringrequired
items[].​product.​pricestringrequired
Example: "99.99"
items[].​product.​display_pricestringrequired
Example: "؋99.99 (AFN)"
items[].​product.​subscription_pricestringrequired
Example: "99.99"
items[].​product.​display_subscription_pricestringrequired
Example: "؋99.99 (AFN)"
items[].​product.​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_pricestringrequired
Example: "؋0.00 (AFN)"
items[].​product.​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_subscription_pricestringrequired
Example: "؋0.00 (AFN)"
items[].​product.​shippingstringrequired
Example: "0.0"
items[].​product.​imageobject(Image3)required
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
items[].​product.​image.​ministringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​detailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​fullstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image_urlstringrequired
Example: "https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png"
items[].​product.​skustringrequired
Example: "ABC1234"
items[].​product.​country_codestringrequired
Example: "us"
items[].​product.​country_idinteger(int32)required
Example: 1
items[].​product.​viewsinteger(int32)required
items[].​product.​leadsinteger(int32)required
items[].​product.​share_linkstringrequired
items[].​product.​commissionstringrequired
Example: "10.0"
items[].​product.​publicbooleanrequired
Example: true
items[].​product.​shopify_idstringrequired
items[].​product.​shopify_handlestringrequired
items[].​product.​in_stockbooleanrequired
Example: true
items[].​product.​vendorstringrequired
items[].​product.​price_rangeArray of stringsrequired
Example: ["$99.99","$99.99"]
items[].​product.​price_range_formattedstringrequired
Example: "$99.99"
items[].​product.​unlimited_inventorybooleanrequired
items[].​product.​default_variantobject(DefaultVariant2)required
Example: {"id":27306,"product_id":6684,"shopify_id":null,"title":null,"sku":"ABC1234","position":15756,"inventory_policy":"none","taxable":true,"inventory_quantity":1,"created_at":"2023-12-19T11:52:57.058Z","updated_at":"2023-12-19T11:52:57.058Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":null,"size":null,"physical":true,"unit_of_weight":null,"height":null,"width":null,"length":null,"unit_of_size":null,"hs_code":null,"country_of_origin":null,"customs_information_shipping":true,"active":true,"bar_code":null,"track_quantity":true,"keep_selling":false,"option_attrs":[],"allow_subscription":true}
items[].​product.​default_variant.​idinteger(int32)required
Example: 27306
items[].​product.​default_variant.​product_idinteger(int32)required
Example: 6684
items[].​product.​default_variant.​shopify_idstringrequired
items[].​product.​default_variant.​titlestringrequired
items[].​product.​default_variant.​skustringrequired
Example: "ABC1234"
items[].​product.​default_variant.​positioninteger(int32)required
Example: 15756
items[].​product.​default_variant.​inventory_policystringrequired
Example: "none"
items[].​product.​default_variant.​taxablebooleanrequired
Example: true
items[].​product.​default_variant.​inventory_quantityinteger(int32)required
Example: 1
items[].​product.​default_variant.​created_atstringrequired
Example: "2023-12-19T11:52:57.058Z"
items[].​product.​default_variant.​updated_atstringrequired
Example: "2023-12-19T11:52:57.058Z"
items[].​product.​default_variant.​external_idstringrequired
items[].​product.​default_variant.​variant_country_idstringrequired
items[].​product.​default_variant.​image_urlstringrequired
items[].​product.​default_variant.​image_pathstringrequired
items[].​product.​default_variant.​is_masterbooleanrequired
Example: true
items[].​product.​default_variant.​discarded_atstringrequired
items[].​product.​default_variant.​pricestringrequired
items[].​product.​default_variant.​weightstringrequired
items[].​product.​default_variant.​sizestringrequired
items[].​product.​default_variant.​physicalbooleanrequired
Example: true
items[].​product.​default_variant.​unit_of_weightstringrequired
items[].​product.​default_variant.​heightstringrequired
items[].​product.​default_variant.​widthstringrequired
items[].​product.​default_variant.​lengthstringrequired
items[].​product.​default_variant.​unit_of_sizestringrequired
items[].​product.​default_variant.​hs_codestringrequired
items[].​product.​default_variant.​country_of_originstringrequired
items[].​product.​default_variant.​customs_information_shippingbooleanrequired
Example: true
items[].​product.​default_variant.​activebooleanrequired
Example: true
items[].​product.​default_variant.​bar_codestringrequired
items[].​product.​default_variant.​track_quantitybooleanrequired
Example: true
items[].​product.​default_variant.​keep_sellingbooleanrequired
items[].​product.​default_variant.​option_attrsArray of stringsrequired
Example: []
items[].​product.​default_variant.​allow_subscriptionbooleanrequired
Example: true
items[].​product.​currency_symbolstringrequired
Example: "؋"
items[].​product.​currency_codestringrequired
Example: "AFN"
items[].​product.​average_ratinginteger(int32)required
items[].​product.​option_valuesobjectrequired
Example: {}
items[].​product.​publish_to_retail_storebooleanrequired
Example: true
items[].​product.​publish_to_rep_storebooleanrequired
Example: true
items[].​product.​publish_to_share_tabbooleanrequired
Example: true
items[].​product.​imagesArray of stringsrequired
Example: []
items[].​product.​countriesArray of objects(Country7)required
Example: [{"id":24,"iso_name":"BHUTAN","iso":"BT","iso3":"BTN","name":"Bhutan","numcode":64,"active":true,"currency_code":"BTN","currency_symbol":"Nu.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":39,"iso_name":"CHAD","iso":"TD","iso3":"TCD","name":"Chad","numcode":148,"active":true,"currency_code":"XAF","currency_symbol":"CFA","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":92,"iso_name":"INDIA","iso":"IN","iso3":"IND","name":"India","numcode":356,"active":true,"currency_code":"INR","currency_symbol":"₹","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":131,"iso_name":"MICRONESIA, FEDERATED STATES OF","iso":"FM","iso3":"FSM","name":"Micronesia, Federated States of","numcode":583,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":148,"iso_name":"NIGERIA","iso":"NG","iso3":"NGA","name":"Nigeria","numcode":566,"active":true,"currency_code":"NGN","currency_symbol":"₦","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":179,"iso_name":"SENEGAL","iso":"SN","iso3":"SEN","name":"Senegal","numcode":686,"active":true,"currency_code":"XOF","currency_symbol":"Fr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":205,"iso_name":"TUNISIA","iso":"TN","iso3":"TUN","name":"Tunisia","numcode":788,"active":true,"currency_code":"TND","currency_symbol":"د.ت","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":5,"iso_name":"ANDORRA","iso":"AD","iso3":"AND","name":"Andorra","numcode":20,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":6,"iso_name":"ANGOLA","iso":"AO","iso3":"AGO","name":"Angola","numcode":24,"active":true,"currency_code":"AOA","currency_symbol":"Kz","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":7,"iso_name":"ANGUILLA","iso":"AI","iso3":"AIA","name":"Anguilla","numcode":660,"active":true,"currency_code":"XCD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":8,"iso_name":"ANTIGUA AND BARBUDA","iso":"AG","iso3":"ATG","name":"Antigua and Barbuda","numcode":28,"active":true,"currency_code":"XCD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":78,"iso_name":"GREENLAND","iso":"GL","iso3":"GRL","name":"Greenland","numcode":304,"active":true,"currency_code":"DKK","currency_symbol":"kr.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":35,"iso_name":"CANADA","iso":"CA","iso3":"CAN","name":"Canada","numcode":124,"active":true,"currency_code":"CAD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":142,"iso_name":"NETHERLANDS","iso":"NL","iso3":"NLD","name":"Netherlands","numcode":528,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":144,"iso_name":"NEW CALEDONIA","iso":"NC","iso3":"NCL","name":"New Caledonia","numcode":540,"active":true,"currency_code":"XPF","currency_symbol":"Fr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":192,"iso_name":"SVALBARD AND JAN MAYEN","iso":"SJ","iso3":"SJM","name":"Svalbard and Jan Mayen","numcode":744,"active":true,"currency_code":"NOK","currency_symbol":"kr","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":224,"iso_name":"YEMEN","iso":"YE","iso3":"YEM","name":"Yemen","numcode":887,"active":true,"currency_code":"YER","currency_symbol":"﷼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
items[].​product.​countries[].​idinteger(int32)required
Example: 27
items[].​product.​countries[].​iso_namestringrequired
Example: "BOTSWANA"
items[].​product.​countries[].​isostringrequired
Example: "BW"
items[].​product.​countries[].​iso3stringrequired
Example: "BWA"
items[].​product.​countries[].​namestringrequired
Example: "Botswana"
items[].​product.​countries[].​numcodeinteger(int32)required
Example: 72
items[].​product.​countries[].​activebooleanrequired
Example: true
items[].​product.​countries[].​currency_codestringrequired
Example: "BWP"
items[].​product.​countries[].​currency_symbolstringrequired
Example: "P"
items[].​product.​countries[].​separatorstringrequired
Example: "."
items[].​product.​countries[].​delimiterstringrequired
Example: ","
items[].​product.​countries[].​address3booleanrequired
items[].​product.​countries[].​statebooleanrequired
Example: true
items[].​product.​countries[].​passportbooleanrequired
items[].​product.​countries[].​itnbooleanrequired
items[].​product.​countries[].​tax_rateinteger(int32)required
items[].​product.​variantsArray of objects(Variant8)required
Example: [{"id":27306,"title":null,"image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":3147116,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋99.99 (AFN)","country_iso":"AF","subscription_price":"99.99","display_wholesale_price":"؋0.00 (AFN)","display_wholesale_subscription_price":"؋0.00 (AFN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}},{"id":3147117,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ALL","currency_symbol":"L","display_price":"L99.99 (ALL)","country_iso":"AL","subscription_price":"99.99","display_wholesale_price":"L0.00 (ALL)","display_wholesale_subscription_price":"L0.00 (ALL)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":2,"iso":"AL","iso_name":"ALBANIA","iso3":"ALB","name":"Albania","tax_rate":0}},{"id":3147118,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DZD","currency_symbol":"د.ج","display_price":"د.ج99.99 (DZD)","country_iso":"DZ","subscription_price":"99.99","display_wholesale_price":"د.ج0.00 (DZD)","display_wholesale_subscription_price":"د.ج0.00 (DZD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":3,"iso":"DZ","iso_name":"ALGERIA","iso3":"DZA","name":"Algeria","tax_rate":0}},{"id":3147119,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AD","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":5,"iso":"AD","iso_name":"ANDORRA","iso3":"AND","name":"Andorra","tax_rate":0}},{"id":3147120,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AOA","currency_symbol":"Kz","display_price":"Kz99.99 (AOA)","country_iso":"AO","subscription_price":"99.99","display_wholesale_price":"Kz0.00 (AOA)","display_wholesale_subscription_price":"Kz0.00 (AOA)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":6,"iso":"AO","iso_name":"ANGOLA","iso3":"AGO","name":"Angola","tax_rate":0}},{"id":3147121,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AI","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":7,"iso":"AI","iso_name":"ANGUILLA","iso3":"AIA","name":"Anguilla","tax_rate":0}},{"id":3147122,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AG","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":8,"iso":"AG","iso_name":"ANTIGUA AND BARBUDA","iso3":"ATG","name":"Antigua and Barbuda","tax_rate":0}},{"id":3147123,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ARS","currency_symbol":"$","display_price":"$99.99 (ARS)","country_iso":"AR","subscription_price":"99.99","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":3147124,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AUD","currency_symbol":"$","display_price":"$99.99 (AUD)","country_iso":"AU","subscription_price":"99.99","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":3147125,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AT","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":3147126,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼99.99 (AZN)","country_iso":"AZ","subscription_price":"99.99","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":3147127,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BSD","currency_symbol":"$","display_price":"$99.99 (BSD)","country_iso":"BS","subscription_price":"99.99","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":3147128,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب99.990 (BHD)","country_iso":"BH","subscription_price":"99.99","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":3147129,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.99.99 (BTN)","country_iso":"BT","subscription_price":"99.99","display_wholesale_price":"Nu.0.00 (BTN)","display_wholesale_subscription_price":"Nu.0.00 (BTN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":3147130,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"CAD","currency_symbol":"$","display_price":"$99.99 (CAD)","country_iso":"CA","subscription_price":"99.99","display_wholesale_price":"$0.00 (CAD)","display_wholesale_subscription_price":"$0.00 (CAD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":35,"iso":"CA","iso_name":"CANADA","iso3":"CAN","name":"Canada","tax_rate":0}},{"id":3147131,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XAF","currency_symbol":"CFA","display_price":"CFA100 (XAF)","country_iso":"TD","subscription_price":"99.99","display_wholesale_price":"CFA0 (XAF)","display_wholesale_subscription_price":"CFA0 (XAF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":39,"iso":"TD","iso_name":"CHAD","iso3":"TCD","name":"Chad","tax_rate":0}},{"id":3147132,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"DE","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":74,"iso":"DE","iso_name":"GERMANY","iso3":"DEU","name":"Germany","tax_rate":0}},{"id":3147133,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DKK","currency_symbol":"kr.","display_price":"kr.99.99 (DKK)","country_iso":"GL","subscription_price":"99.99","display_wholesale_price":"kr.0.00 (DKK)","display_wholesale_subscription_price":"kr.0.00 (DKK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":78,"iso":"GL","iso_name":"GREENLAND","iso3":"GRL","name":"Greenland","tax_rate":0}},{"id":3147134,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"INR","currency_symbol":"₹","display_price":"₹99.99 (INR)","country_iso":"IN","subscription_price":"99.99","display_wholesale_price":"₹0.00 (INR)","display_wholesale_subscription_price":"₹0.00 (INR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":92,"iso":"IN","iso_name":"INDIA","iso3":"IND","name":"India","tax_rate":0}},{"id":3147135,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"FM","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":131,"iso":"FM","iso_name":"MICRONESIA, FEDERATED STATES OF","iso3":"FSM","name":"Micronesia, Federated States of","tax_rate":0}},{"id":3147136,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.99.99 (NPR)","country_iso":"NP","subscription_price":"99.99","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":3147137,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"NL","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":142,"iso":"NL","iso_name":"NETHERLANDS","iso3":"NLD","name":"Netherlands","tax_rate":0}},{"id":3147138,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XPF","currency_symbol":"Fr","display_price":"Fr100 (XPF)","country_iso":"NC","subscription_price":"99.99","display_wholesale_price":"Fr0 (XPF)","display_wholesale_subscription_price":"Fr0 (XPF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":144,"iso":"NC","iso_name":"NEW CALEDONIA","iso3":"NCL","name":"New Caledonia","tax_rate":0}},{"id":3147139,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NGN","currency_symbol":"₦","display_price":"₦99.99 (NGN)","country_iso":"NG","subscription_price":"99.99","display_wholesale_price":"₦0.00 (NGN)","display_wholesale_subscription_price":"₦0.00 (NGN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":148,"iso":"NG","iso_name":"NIGERIA","iso3":"NGA","name":"Nigeria","tax_rate":0}},{"id":3147140,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XOF","currency_symbol":"Fr","display_price":"Fr100 (XOF)","country_iso":"SN","subscription_price":"99.99","display_wholesale_price":"Fr0 (XOF)","display_wholesale_subscription_price":"Fr0 (XOF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":179,"iso":"SN","iso_name":"SENEGAL","iso3":"SEN","name":"Senegal","tax_rate":0}},{"id":3147141,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NOK","currency_symbol":"kr","display_price":"kr99.99 (NOK)","country_iso":"SJ","subscription_price":"99.99","display_wholesale_price":"kr0.00 (NOK)","display_wholesale_subscription_price":"kr0.00 (NOK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":192,"iso":"SJ","iso_name":"SVALBARD AND JAN MAYEN","iso3":"SJM","name":"Svalbard and Jan Mayen","tax_rate":0}},{"id":3147142,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"TND","currency_symbol":"د.ت","display_price":"د.ت99.990 (TND)","country_iso":"TN","subscription_price":"99.99","display_wholesale_price":"د.ت0.000 (TND)","display_wholesale_subscription_price":"د.ت0.000 (TND)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":205,"iso":"TN","iso_name":"TUNISIA","iso3":"TUN","name":"Tunisia","tax_rate":0}},{"id":3147143,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"US","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}},{"id":3147144,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"YER","currency_symbol":"﷼","display_price":"﷼99.99 (YER)","country_iso":"YE","subscription_price":"99.99","display_wholesale_price":"﷼0.00 (YER)","display_wholesale_subscription_price":"﷼0.00 (YER)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":224,"iso":"YE","iso_name":"YEMEN","iso3":"YEM","name":"Yemen","tax_rate":0}}]}]
items[].​product.​variants[].​idinteger(int32)required
Example: 27306
items[].​product.​variants[].​titlestringrequired
items[].​product.​variants[].​image_urlstringrequired
items[].​product.​variants[].​buyablebooleanrequired
Example: true
items[].​product.​variants[].​option_value_idsArray of stringsrequired
Example: []
items[].​product.​variants[].​allow_subscriptionbooleanrequired
Example: true
items[].​product.​variants[].​variant_countriesArray of objects(VariantCountries5)required
Example: [{"id":3147116,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AFN","currency_symbol":"؋","display_price":"؋99.99 (AFN)","country_iso":"AF","subscription_price":"99.99","display_wholesale_price":"؋0.00 (AFN)","display_wholesale_subscription_price":"؋0.00 (AFN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":1,"iso":"AF","iso_name":"AFGHANISTAN","iso3":"AFG","name":"Afghanistan","tax_rate":0}},{"id":3147117,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ALL","currency_symbol":"L","display_price":"L99.99 (ALL)","country_iso":"AL","subscription_price":"99.99","display_wholesale_price":"L0.00 (ALL)","display_wholesale_subscription_price":"L0.00 (ALL)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":2,"iso":"AL","iso_name":"ALBANIA","iso3":"ALB","name":"Albania","tax_rate":0}},{"id":3147118,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DZD","currency_symbol":"د.ج","display_price":"د.ج99.99 (DZD)","country_iso":"DZ","subscription_price":"99.99","display_wholesale_price":"د.ج0.00 (DZD)","display_wholesale_subscription_price":"د.ج0.00 (DZD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":3,"iso":"DZ","iso_name":"ALGERIA","iso3":"DZA","name":"Algeria","tax_rate":0}},{"id":3147119,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AD","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":5,"iso":"AD","iso_name":"ANDORRA","iso3":"AND","name":"Andorra","tax_rate":0}},{"id":3147120,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AOA","currency_symbol":"Kz","display_price":"Kz99.99 (AOA)","country_iso":"AO","subscription_price":"99.99","display_wholesale_price":"Kz0.00 (AOA)","display_wholesale_subscription_price":"Kz0.00 (AOA)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":6,"iso":"AO","iso_name":"ANGOLA","iso3":"AGO","name":"Angola","tax_rate":0}},{"id":3147121,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AI","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":7,"iso":"AI","iso_name":"ANGUILLA","iso3":"AIA","name":"Anguilla","tax_rate":0}},{"id":3147122,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XCD","currency_symbol":"$","display_price":"$99.99 (XCD)","country_iso":"AG","subscription_price":"99.99","display_wholesale_price":"$0.00 (XCD)","display_wholesale_subscription_price":"$0.00 (XCD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":8,"iso":"AG","iso_name":"ANTIGUA AND BARBUDA","iso3":"ATG","name":"Antigua and Barbuda","tax_rate":0}},{"id":3147123,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"ARS","currency_symbol":"$","display_price":"$99.99 (ARS)","country_iso":"AR","subscription_price":"99.99","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":3147124,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AUD","currency_symbol":"$","display_price":"$99.99 (AUD)","country_iso":"AU","subscription_price":"99.99","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":3147125,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"AT","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":3147126,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼99.99 (AZN)","country_iso":"AZ","subscription_price":"99.99","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":3147127,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BSD","currency_symbol":"$","display_price":"$99.99 (BSD)","country_iso":"BS","subscription_price":"99.99","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":3147128,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب99.990 (BHD)","country_iso":"BH","subscription_price":"99.99","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":3147129,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"BTN","currency_symbol":"Nu.","display_price":"Nu.99.99 (BTN)","country_iso":"BT","subscription_price":"99.99","display_wholesale_price":"Nu.0.00 (BTN)","display_wholesale_subscription_price":"Nu.0.00 (BTN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":24,"iso":"BT","iso_name":"BHUTAN","iso3":"BTN","name":"Bhutan","tax_rate":0}},{"id":3147130,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"CAD","currency_symbol":"$","display_price":"$99.99 (CAD)","country_iso":"CA","subscription_price":"99.99","display_wholesale_price":"$0.00 (CAD)","display_wholesale_subscription_price":"$0.00 (CAD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":35,"iso":"CA","iso_name":"CANADA","iso3":"CAN","name":"Canada","tax_rate":0}},{"id":3147131,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XAF","currency_symbol":"CFA","display_price":"CFA100 (XAF)","country_iso":"TD","subscription_price":"99.99","display_wholesale_price":"CFA0 (XAF)","display_wholesale_subscription_price":"CFA0 (XAF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":39,"iso":"TD","iso_name":"CHAD","iso3":"TCD","name":"Chad","tax_rate":0}},{"id":3147132,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"DE","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":74,"iso":"DE","iso_name":"GERMANY","iso3":"DEU","name":"Germany","tax_rate":0}},{"id":3147133,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"DKK","currency_symbol":"kr.","display_price":"kr.99.99 (DKK)","country_iso":"GL","subscription_price":"99.99","display_wholesale_price":"kr.0.00 (DKK)","display_wholesale_subscription_price":"kr.0.00 (DKK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":78,"iso":"GL","iso_name":"GREENLAND","iso3":"GRL","name":"Greenland","tax_rate":0}},{"id":3147134,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"INR","currency_symbol":"₹","display_price":"₹99.99 (INR)","country_iso":"IN","subscription_price":"99.99","display_wholesale_price":"₹0.00 (INR)","display_wholesale_subscription_price":"₹0.00 (INR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":92,"iso":"IN","iso_name":"INDIA","iso3":"IND","name":"India","tax_rate":0}},{"id":3147135,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"FM","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":131,"iso":"FM","iso_name":"MICRONESIA, FEDERATED STATES OF","iso3":"FSM","name":"Micronesia, Federated States of","tax_rate":0}},{"id":3147136,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.99.99 (NPR)","country_iso":"NP","subscription_price":"99.99","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":3147137,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"EUR","currency_symbol":"€","display_price":"€99.99 (EUR)","country_iso":"NL","subscription_price":"99.99","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":142,"iso":"NL","iso_name":"NETHERLANDS","iso3":"NLD","name":"Netherlands","tax_rate":0}},{"id":3147138,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XPF","currency_symbol":"Fr","display_price":"Fr100 (XPF)","country_iso":"NC","subscription_price":"99.99","display_wholesale_price":"Fr0 (XPF)","display_wholesale_subscription_price":"Fr0 (XPF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":144,"iso":"NC","iso_name":"NEW CALEDONIA","iso3":"NCL","name":"New Caledonia","tax_rate":0}},{"id":3147139,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NGN","currency_symbol":"₦","display_price":"₦99.99 (NGN)","country_iso":"NG","subscription_price":"99.99","display_wholesale_price":"₦0.00 (NGN)","display_wholesale_subscription_price":"₦0.00 (NGN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":148,"iso":"NG","iso_name":"NIGERIA","iso3":"NGA","name":"Nigeria","tax_rate":0}},{"id":3147140,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"XOF","currency_symbol":"Fr","display_price":"Fr100 (XOF)","country_iso":"SN","subscription_price":"99.99","display_wholesale_price":"Fr0 (XOF)","display_wholesale_subscription_price":"Fr0 (XOF)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":179,"iso":"SN","iso_name":"SENEGAL","iso3":"SEN","name":"Senegal","tax_rate":0}},{"id":3147141,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"NOK","currency_symbol":"kr","display_price":"kr99.99 (NOK)","country_iso":"SJ","subscription_price":"99.99","display_wholesale_price":"kr0.00 (NOK)","display_wholesale_subscription_price":"kr0.00 (NOK)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":192,"iso":"SJ","iso_name":"SVALBARD AND JAN MAYEN","iso3":"SJM","name":"Svalbard and Jan Mayen","tax_rate":0}},{"id":3147142,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"TND","currency_symbol":"د.ت","display_price":"د.ت99.990 (TND)","country_iso":"TN","subscription_price":"99.99","display_wholesale_price":"د.ت0.000 (TND)","display_wholesale_subscription_price":"د.ت0.000 (TND)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":205,"iso":"TN","iso_name":"TUNISIA","iso3":"TUN","name":"Tunisia","tax_rate":0}},{"id":3147143,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"USD","currency_symbol":"$","display_price":"$99.99 (USD)","country_iso":"US","subscription_price":"99.99","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}},{"id":3147144,"price":"99.99","shipping":"0.0","tax":"0.0","currency_code":"YER","currency_symbol":"﷼","display_price":"﷼99.99 (YER)","country_iso":"YE","subscription_price":"99.99","display_wholesale_price":"﷼0.00 (YER)","display_wholesale_subscription_price":"﷼0.00 (YER)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":224,"iso":"YE","iso_name":"YEMEN","iso3":"YEM","name":"Yemen","tax_rate":0}}]
items[].​product.​variants[].​variant_countries[].​idinteger(int32)required
Example: 130789
items[].​product.​variants[].​variant_countries[].​pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​shippingstringrequired
Example: "500.0"
items[].​product.​variants[].​variant_countries[].​taxstringrequired
Example: "200.0"
items[].​product.​variants[].​variant_countries[].​currency_codestringrequired
Example: "ARS"
items[].​product.​variants[].​variant_countries[].​currency_symbolstringrequired
Example: "$"
items[].​product.​variants[].​variant_countries[].​display_pricestringrequired
Example: "$9,800.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​country_isostringrequired
Example: "AR"
items[].​product.​variants[].​variant_countries[].​subscription_pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​display_wholesale_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​display_wholesale_subscription_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​countryobject(Country8)required
Example: {"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}
items[].​product.​optionsArray of stringsrequired
Example: []
items[].​product.​promptsArray of stringsrequired
Example: []
items[].​product.​enroll_productsArray of stringsrequired
Example: []
items[].​product.​enrollsArray of stringsrequired
Example: []
tracking_informationsArray of stringsrequired
Example: []
Response
application/json; charset=utf-8
{
  "id": 10276,
  "order_number": "K5124124",
  "amount": "218.73",
  "shipping": "0.0",
  "tax": "0.0",
  "subtotal": "0.0",
  "first_name": "Gavin",
  "last_name": "Belson",
  "email": "gavin@hooli.com",
  "phone": null,
  "tracking": null,
  "cv": 0,
  "qv": 0,
  "status": "awaiting_shipment",
  "order_type": "imported",
  "rating": 1,
  "review": null,
  "referrer": "Mike Tingey",
  "friendly_status": "paid",
  "type": null,
  "created_at": "2023-12-19T11:52:57.474Z",
  "currency_code": "AFN",
  "currency_symbol": "؋",
  "display_amount": "؋218.73 (AFN)",
  "display_subtotal": "؋0.00 (AFN)",
  "display_tax": "؋0.00 (AFN)",
  "display_shipping": "؋0.00 (AFN)",
  "display_refunds": "(0 CV, 0 QV) -؋0.00 (AFN)",
  "display_discount": "؋0.00 (AFN)",
  "order_thumbnail": "https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png",
  "sale_date": "2023-12-19T11:52:57.474Z",
  "recognized_ship_date": null,
  "refundable": false,
  "max_refundable_amount": "218.73",
  "max_refundable_tax": "0.0",
  "max_refundable_shipping": "0.0",
  "max_refundable_product_price": "0.0",
  "ship_to": {
    "id": 980200545,
    "name": null,
    "address1": "506 W 1060 N",
    "address2": null,
    "address3": null,
    "city": "American Fork",
    "state": "UT",
    "postal_code": "84003",
    "country_code": null,
    "country": null,
    "default": false
  },
  "bill_to": null,
  "contact": {
    "id": 18105,
    "token": "H8HneojRWb3qhs6mkNsCmAv3",
    "first_name": "Gavin",
    "last_name": "Belson",
    "avatar_url": null,
    "status": "new",
    "email": "gavin@hooli.com",
    "email2": null,
    "phone": null,
    "phone2": null,
    "phone_id": null,
    "address": null,
    "address2": null,
    "city": null,
    "state": null,
    "postal_code": null,
    "language_id": null,
    "country_id": null,
    "lead_type": null,
    "ip": null,
    "requested_at": null,
    "best_time": null,
    "time_zone": null,
    "reason": null,
    "income": null,
    "hours": null,
    "invest": null,
    "interest": null,
    "full_name": "Gavin Belson"
  },
  "items": [
    { … }
  ],
  "tracking_informations": []
}

Get Company Order Details

Request

Retrieves detailed information about a specific company order.

Path
orderIdstringrequired

The unique identifier of the order to retrieve

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/orders/{orderId}.json'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
Example: 8768
order_numberstringrequired
Example: "F32799720937756"
amountstringrequired
Example: "16900.0"
shippingstringrequired
Example: "650.0"
taxstringrequired
Example: "260.0"
subtotalstringrequired
Example: "12740.0"
first_namestringrequired
Example: "Bishal"
last_namestringrequired
Example: "Nepal"
emailstringrequired
Example: "bnepal05579887@gmail.com"
phonestringrequired
trackingstringrequired
cvinteger(int32)required
Example: 5
qvinteger(int32)required
statusstringrequired
Example: "awaiting_shipment"
order_typestringrequired
Example: "purchased"
ratinginteger(int32)required
reviewstringrequired
referrerstringrequired
Example: "Bishal Nepal"
friendly_statusstringrequired
Example: "paid"
typestringrequired
created_atstringrequired
Example: "2023-03-15T11:10:53.263Z"
currency_codestringrequired
Example: "NPR"
currency_symbolstringrequired
Example: "Rs."
display_amountstringrequired
Example: "Rs.16,900.00 (NPR)"
display_subtotalstringrequired
Example: "Rs.12,740.00 (NPR)"
display_taxstringrequired
Example: "Rs.260.00 (NPR)"
display_shippingstringrequired
Example: "Rs.650.00 (NPR)"
display_refundsstringrequired
Example: "(0 CV, 0 QV) -Rs.0.00 (NPR)"
display_discountstringrequired
Example: "Rs.0.00 (NPR)"
order_thumbnailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
sale_datestringrequired
recognized_ship_datestringrequired
refundablebooleanrequired
Example: true
max_refundable_amountstringrequired
Example: "16900.0"
max_refundable_taxstringrequired
Example: "260.0"
max_refundable_shippingstringrequired
Example: "650.0"
max_refundable_product_pricestringrequired
Example: "12740.0"
display_enrollment_feestringrequired
Example: "Rs.3,250.00 (NPR)"
ship_toobject(ShipTo5)required
Example: {"id":980199006,"name":"Bishal Nepal","address1":"jhapa","address2":null,"address3":null,"city":"damak","state":"Province 1","postal_code":"mechi","country_code":null,"country":{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0,"default":false,"created_at":"2022-05-09T05:12:21.806Z","updated_at":"2022-05-09T05:12:21.806Z","geo_entity_id":28},"default":false}
ship_to.​idinteger(int32)required
Example: 980199006
ship_to.​namestringrequired
Example: "Bishal Nepal"
ship_to.​address1stringrequired
Example: "jhapa"
ship_to.​address2stringrequired
ship_to.​address3stringrequired
ship_to.​citystringrequired
Example: "damak"
ship_to.​statestringrequired
Example: "Province 1"
ship_to.​postal_codestringrequired
Example: "mechi"
ship_to.​country_codestringrequired
ship_to.​countryobject(Country6)required
Example: {"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0,"default":false,"created_at":"2022-05-09T05:12:21.806Z","updated_at":"2022-05-09T05:12:21.806Z","geo_entity_id":28}
ship_to.​country.​idinteger(int32)required
Example: 141
ship_to.​country.​iso_namestringrequired
Example: "NEPAL"
ship_to.​country.​isostringrequired
Example: "NP"
ship_to.​country.​iso3stringrequired
Example: "NPL"
ship_to.​country.​namestringrequired
Example: "Nepal"
ship_to.​country.​numcodeinteger(int32)required
Example: 524
ship_to.​country.​activebooleanrequired
Example: true
ship_to.​country.​currency_codestringrequired
Example: "NPR"
ship_to.​country.​currency_symbolstringrequired
Example: "Rs."
ship_to.​country.​separatorstringrequired
Example: "."
ship_to.​country.​delimiterstringrequired
Example: ","
ship_to.​country.​address3booleanrequired
ship_to.​country.​statebooleanrequired
Example: true
ship_to.​country.​passportbooleanrequired
ship_to.​country.​itnbooleanrequired
ship_to.​country.​tax_rateinteger(int32)required
ship_to.​country.​defaultbooleanrequired
ship_to.​country.​created_atstringrequired
Example: "2022-05-09T05:12:21.806Z"
ship_to.​country.​updated_atstringrequired
Example: "2022-05-09T05:12:21.806Z"
ship_to.​country.​geo_entity_idinteger(int32)required
Example: 28
ship_to.​defaultbooleanrequired
contactobject(Contact)required
Example: {"id":6557,"token":"h59g4H8EExXpmNYmhq4woiMh","first_name":"Bishal","last_name":"Nepal","avatar_url":null,"status":null,"email":"bnepal05579887@gmail.com","email2":null,"phone":null,"phone2":null,"phone_id":null,"address":null,"address2":null,"city":null,"state":null,"postal_code":null,"language_id":null,"country_id":null,"lead_type":null,"ip":null,"requested_at":null,"best_time":null,"time_zone":null,"reason":null,"income":null,"hours":null,"invest":null,"interest":null,"full_name":"Bishal Nepal"}
contact.​idinteger(int32)required
Example: 6557
contact.​tokenstringrequired
Example: "h59g4H8EExXpmNYmhq4woiMh"
contact.​first_namestringrequired
Example: "Bishal"
contact.​last_namestringrequired
Example: "Nepal"
contact.​avatar_urlstringrequired
contact.​statusstringrequired
contact.​emailstringrequired
Example: "bnepal05579887@gmail.com"
contact.​email2stringrequired
contact.​phonestringrequired
contact.​phone2stringrequired
contact.​phone_idstringrequired
contact.​addressstringrequired
contact.​address2stringrequired
contact.​citystringrequired
contact.​statestringrequired
contact.​postal_codestringrequired
contact.​language_idstringrequired
contact.​country_idstringrequired
contact.​lead_typestringrequired
contact.​ipstringrequired
contact.​requested_atstringrequired
contact.​best_timestringrequired
contact.​time_zonestringrequired
contact.​reasonstringrequired
contact.​incomestringrequired
contact.​hoursstringrequired
contact.​investstringrequired
contact.​intereststringrequired
contact.​full_namestringrequired
Example: "Bishal Nepal"
itemsArray of objects(Item3)required
Example: [{"id":8803,"quantity":1,"price":12740,"ordered_variant":"","sku":"sketch12","product":{"id":2240,"active":true,"title":"sketch","description":{"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"},"stripped":"best selling sketch","price":"12740.0","display_price":"Rs.12,740.00 (NPR)","subscription_price":"12740.0","display_subscription_price":"Rs.12,740.00 (NPR)","wholesale_price":"0.0","display_wholesale_price":"Rs.0.00 (NPR)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"Rs.0.00 (NPR)","shipping":"5.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","sku":"sketch","country_code":"ar","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.12,740.00"],"price_range_formatted":"Rs.0.00 - Rs.12,740.00","unlimited_inventory":false,"default_variant":{"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true},"currency_symbol":"Rs.","currency_code":"NPR","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"images":[{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}],"countries":[{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}],"enrolls":[{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]}}]
items[].​idinteger(int32)required
Example: 8803
items[].​quantityinteger(int32)required
Example: 1
items[].​priceinteger(int32)required
Example: 12740
items[].​ordered_variantstringrequired
items[].​skustringrequired
Example: "sketch12"
items[].​productobject(Product10)required
Example: {"id":2240,"active":true,"title":"sketch","description":{"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"},"stripped":"best selling sketch","price":"12740.0","display_price":"Rs.12,740.00 (NPR)","subscription_price":"12740.0","display_subscription_price":"Rs.12,740.00 (NPR)","wholesale_price":"0.0","display_wholesale_price":"Rs.0.00 (NPR)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"Rs.0.00 (NPR)","shipping":"5.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","sku":"sketch","country_code":"ar","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.12,740.00"],"price_range_formatted":"Rs.0.00 - Rs.12,740.00","unlimited_inventory":false,"default_variant":{"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true},"currency_symbol":"Rs.","currency_code":"NPR","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"images":[{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}],"countries":[{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}],"enrolls":[{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]}
items[].​product.​idinteger(int32)required
Example: 2240
items[].​product.​activebooleanrequired
Example: true
items[].​product.​titlestringrequired
Example: "sketch"
items[].​product.​descriptionobject(Description)required
Example: {"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"}
items[].​product.​description.​idinteger(int32)required
Example: 4836
items[].​product.​description.​namestringrequired
Example: "description"
items[].​product.​description.​bodystringrequired
Example: "<div>best selling sketch</div>"
items[].​product.​description.​record_typestringrequired
Example: "Product"
items[].​product.​description.​record_idinteger(int32)required
Example: 2240
items[].​product.​description.​created_atstringrequired
Example: "2023-02-02T03:48:16.810Z"
items[].​product.​description.​updated_atstringrequired
Example: "2023-02-02T03:48:16.810Z"
items[].​product.​strippedstringrequired
Example: "best selling sketch"
items[].​product.​pricestringrequired
Example: "12740.0"
items[].​product.​display_pricestringrequired
Example: "Rs.12,740.00 (NPR)"
items[].​product.​subscription_pricestringrequired
Example: "12740.0"
items[].​product.​display_subscription_pricestringrequired
Example: "Rs.12,740.00 (NPR)"
items[].​product.​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_pricestringrequired
Example: "Rs.0.00 (NPR)"
items[].​product.​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_subscription_pricestringrequired
Example: "Rs.0.00 (NPR)"
items[].​product.​shippingstringrequired
Example: "5.0"
items[].​product.​imageobject(Image3)required
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
items[].​product.​image.​ministringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​detailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​fullstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​skustringrequired
Example: "sketch"
items[].​product.​country_codestringrequired
Example: "ar"
items[].​product.​country_idstringrequired
items[].​product.​viewsinteger(int32)required
items[].​product.​leadsinteger(int32)required
items[].​product.​share_linkstringrequired
items[].​product.​commissionstringrequired
Example: "10.0"
items[].​product.​publicbooleanrequired
Example: true
items[].​product.​shopify_idstringrequired
items[].​product.​shopify_handlestringrequired
items[].​product.​in_stockbooleanrequired
Example: true
items[].​product.​vendorstringrequired
items[].​product.​price_rangeArray of stringsrequired
Example: ["Rs.0.00","Rs.12,740.00"]
items[].​product.​price_range_formattedstringrequired
Example: "Rs.0.00 - Rs.12,740.00"
items[].​product.​unlimited_inventorybooleanrequired
items[].​product.​default_variantobject(DefaultVariant3)required
Example: {"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true}
items[].​product.​default_variant.​idinteger(int32)required
Example: 19630
items[].​product.​default_variant.​product_idinteger(int32)required
Example: 2240
items[].​product.​default_variant.​shopify_idstringrequired
items[].​product.​default_variant.​titlestringrequired
items[].​product.​default_variant.​skustringrequired
Example: "sketch12"
items[].​product.​default_variant.​positioninteger(int32)required
Example: 12698
items[].​product.​default_variant.​inventory_policystringrequired
Example: "none"
items[].​product.​default_variant.​taxablebooleanrequired
Example: true
items[].​product.​default_variant.​inventory_quantityinteger(int32)required
Example: -84
items[].​product.​default_variant.​created_atstringrequired
Example: "2023-02-02T03:48:18.009Z"
items[].​product.​default_variant.​updated_atstringrequired
Example: "2023-09-29T04:59:12.098Z"
items[].​product.​default_variant.​external_idstringrequired
items[].​product.​default_variant.​variant_country_idstringrequired
items[].​product.​default_variant.​image_urlstringrequired
items[].​product.​default_variant.​image_pathstringrequired
items[].​product.​default_variant.​is_masterbooleanrequired
Example: true
items[].​product.​default_variant.​discarded_atstringrequired
items[].​product.​default_variant.​pricestringrequired
items[].​product.​default_variant.​weightstringrequired
items[].​product.​default_variant.​sizestringrequired
items[].​product.​default_variant.​physicalbooleanrequired
Example: true
items[].​product.​default_variant.​unit_of_weightstringrequired
Example: "lb"
items[].​product.​default_variant.​heightinteger(int32)required
items[].​product.​default_variant.​widthinteger(int32)required
items[].​product.​default_variant.​lengthinteger(int32)required
items[].​product.​default_variant.​unit_of_sizestringrequired
Example: "ft"
items[].​product.​default_variant.​hs_codestringrequired
items[].​product.​default_variant.​country_of_originstringrequired
items[].​product.​default_variant.​customs_information_shippingbooleanrequired
items[].​product.​default_variant.​activebooleanrequired
Example: true
items[].​product.​default_variant.​bar_codestringrequired
items[].​product.​default_variant.​track_quantitybooleanrequired
items[].​product.​default_variant.​keep_sellingbooleanrequired
Example: true
items[].​product.​default_variant.​option_attrsArray of stringsrequired
Example: []
items[].​product.​default_variant.​allow_subscriptionbooleanrequired
Example: true
items[].​product.​currency_symbolstringrequired
Example: "Rs."
items[].​product.​currency_codestringrequired
Example: "NPR"
items[].​product.​average_ratinginteger(int32)required
items[].​product.​option_valuesobjectrequired
Example: {}
items[].​product.​publish_to_retail_storebooleanrequired
Example: true
items[].​product.​publish_to_rep_storebooleanrequired
Example: true
items[].​product.​publish_to_share_tabbooleanrequired
Example: true
items[].​product.​imagesArray of objects(Image9)required
Example: [{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}]
items[].​product.​images[].​idinteger(int32)required
Example: 2089
items[].​product.​images[].​imageobject(Image3)required
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
items[].​product.​images[].​image.​ministringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​image.​detailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​image.​fullstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​positionstringrequired
items[].​product.​images[].​shopify_idstringrequired
items[].​product.​countriesArray of objects(Country7)required
Example: [{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
items[].​product.​countries[].​idinteger(int32)required
Example: 27
items[].​product.​countries[].​iso_namestringrequired
Example: "BOTSWANA"
items[].​product.​countries[].​isostringrequired
Example: "BW"
items[].​product.​countries[].​iso3stringrequired
Example: "BWA"
items[].​product.​countries[].​namestringrequired
Example: "Botswana"
items[].​product.​countries[].​numcodeinteger(int32)required
Example: 72
items[].​product.​countries[].​activebooleanrequired
Example: true
items[].​product.​countries[].​currency_codestringrequired
Example: "BWP"
items[].​product.​countries[].​currency_symbolstringrequired
Example: "P"
items[].​product.​countries[].​separatorstringrequired
Example: "."
items[].​product.​countries[].​delimiterstringrequired
Example: ","
items[].​product.​countries[].​address3booleanrequired
items[].​product.​countries[].​statebooleanrequired
Example: true
items[].​product.​countries[].​passportbooleanrequired
items[].​product.​countries[].​itnbooleanrequired
items[].​product.​countries[].​tax_rateinteger(int32)required
items[].​product.​variantsArray of objects(Variant9)required
Example: [{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}]
items[].​product.​variants[].​idinteger(int32)required
Example: 19630
items[].​product.​variants[].​titlestringrequired
items[].​product.​variants[].​image_urlstringrequired
items[].​product.​variants[].​buyablebooleanrequired
Example: true
items[].​product.​variants[].​option_value_idsArray of stringsrequired
Example: []
items[].​product.​variants[].​allow_subscriptionbooleanrequired
Example: true
items[].​product.​variants[].​variant_countriesArray of objects(VariantCountries5)required
Example: [{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]
items[].​product.​variants[].​variant_countries[].​idinteger(int32)required
Example: 130789
items[].​product.​variants[].​variant_countries[].​pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​shippingstringrequired
Example: "500.0"
items[].​product.​variants[].​variant_countries[].​taxstringrequired
Example: "200.0"
items[].​product.​variants[].​variant_countries[].​currency_codestringrequired
Example: "ARS"
items[].​product.​variants[].​variant_countries[].​currency_symbolstringrequired
Example: "$"
items[].​product.​variants[].​variant_countries[].​display_pricestringrequired
Example: "$9,800.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​country_isostringrequired
Example: "AR"
items[].​product.​variants[].​variant_countries[].​subscription_pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​display_wholesale_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​display_wholesale_subscription_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​countryobject(Country8)required
Example: {"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}
items[].​product.​optionsArray of stringsrequired
Example: []
items[].​product.​promptsArray of stringsrequired
Example: []
items[].​product.​enroll_productsArray of objects(EnrollProduct2)required
Example: [{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}]
items[].​product.​enroll_products[].​idinteger(int32)required
Example: 19
items[].​product.​enroll_products[].​product_idinteger(int32)required
Example: 2240
items[].​product.​enroll_products[].​enroll_idinteger(int32)required
Example: 2
items[].​product.​enroll_products[].​activebooleanrequired
Example: true
items[].​product.​enroll_products[].​typestringrequired
Example: "membership_product"
items[].​product.​enroll_products[].​created_atstringrequired
Example: "2023-02-15T06:40:53.303Z"
items[].​product.​enroll_products[].​updated_atstringrequired
Example: "2023-02-15T06:40:53.303Z"
items[].​product.​enrollsArray of objects(Enroll2)required
Example: [{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]
items[].​product.​enrolls[].​idinteger(int32)required
Example: 2
items[].​product.​enrolls[].​integration_idstringrequired
items[].​product.​enrolls[].​fieldsobject(Fields)required
Example: {"dob":"Birthdate","full_name":"Name","government_id":"Government ID"}
items[].​product.​enrolls[].​fields.​dobstringrequired
Example: "Birthdate"
items[].​product.​enrolls[].​fields.​full_namestringrequired
Example: "Name"
items[].​product.​enrolls[].​fields.​government_idstringrequired
Example: "Government ID"
items[].​product.​enrolls[].​member_feeinteger(int32)required
Example: 25
items[].​product.​enrolls[].​member_fee_enabledbooleanrequired
Example: true
items[].​product.​enrolls[].​company_idinteger(int32)required
Example: 980191019
items[].​product.​enrolls[].​created_atstringrequired
Example: "2023-02-01T07:49:12.347Z"
items[].​product.​enrolls[].​updated_atstringrequired
Example: "2023-02-01T07:54:36.961Z"
items[].​product.​enrolls[].​terms_and_conditions_urlstringrequired
Example: "https://www.google.com/"
tracking_informationsArray of stringsrequired
Example: []
Response
application/json; charset=utf-8
{
  "id": 8768,
  "order_number": "F32799720937756",
  "amount": "16900.0",
  "shipping": "650.0",
  "tax": "260.0",
  "subtotal": "12740.0",
  "first_name": "Bishal",
  "last_name": "Nepal",
  "email": "bnepal05579887@gmail.com",
  "phone": null,
  "tracking": null,
  "cv": 5,
  "qv": 0,
  "status": "awaiting_shipment",
  "order_type": "purchased",
  "rating": 0,
  "review": "",
  "referrer": "Bishal Nepal",
  "friendly_status": "paid",
  "type": null,
  "created_at": "2023-03-15T11:10:53.263Z",
  "currency_code": "NPR",
  "currency_symbol": "Rs.",
  "display_amount": "Rs.16,900.00 (NPR)",
  "display_subtotal": "Rs.12,740.00 (NPR)",
  "display_tax": "Rs.260.00 (NPR)",
  "display_shipping": "Rs.650.00 (NPR)",
  "display_refunds": "(0 CV, 0 QV) -Rs.0.00 (NPR)",
  "display_discount": "Rs.0.00 (NPR)",
  "order_thumbnail": "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg",
  "sale_date": null,
  "recognized_ship_date": null,
  "refundable": true,
  "max_refundable_amount": "16900.0",
  "max_refundable_tax": "260.0",
  "max_refundable_shipping": "650.0",
  "max_refundable_product_price": "12740.0",
  "display_enrollment_fee": "Rs.3,250.00 (NPR)",
  "ship_to": {
    "id": 980199006,
    "name": "Bishal Nepal",
    "address1": "jhapa",
    "address2": null,
    "address3": null,
    "city": "damak",
    "state": "Province 1",
    "postal_code": "mechi",
    "country_code": null,
    "country": { … },
    "default": false
  },
  "contact": {
    "id": 6557,
    "token": "h59g4H8EExXpmNYmhq4woiMh",
    "first_name": "Bishal",
    "last_name": "Nepal",
    "avatar_url": null,
    "status": null,
    "email": "bnepal05579887@gmail.com",
    "email2": null,
    "phone": null,
    "phone2": null,
    "phone_id": null,
    "address": null,
    "address2": null,
    "city": null,
    "state": null,
    "postal_code": null,
    "language_id": null,
    "country_id": null,
    "lead_type": null,
    "ip": null,
    "requested_at": null,
    "best_time": null,
    "time_zone": null,
    "reason": null,
    "income": null,
    "hours": null,
    "invest": null,
    "interest": null,
    "full_name": "Bishal Nepal"
  },
  "items": [
    { … }
  ],
  "tracking_informations": []
}

Update Company Order

Request

Updates information for a specific company order using the provided order ID and order details.

Path
orderIdstringrequired

The unique identifier of the order to update

Bodyapplication/jsonrequired
orderobject(Order1)required
Example: {"shipped_on":"2021-01-02","delivered_on":"2021-04-02"}
order.​shipped_onstringrequired
Example: "2021-01-02"
order.​delivered_onstringrequired
Example: "2021-04-02"
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/orders/{orderId}.json' \
  -H 'Content-Type: application/json' \
  -d '{
    "order": {
      "shipped_on": "2021-01-02",
      "delivered_on": "2021-04-02"
    }
  }'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
idinteger(int32)required
Example: 8770
order_numberstringrequired
Example: "F32835649011346"
amountstringrequired
Example: "16900.0"
shippingstringrequired
Example: "650.0"
taxstringrequired
Example: "260.0"
subtotalstringrequired
Example: "12740.0"
first_namestringrequired
Example: "Bishal"
last_namestringrequired
Example: "Nepal"
emailstringrequired
Example: "bnepal05362914@gmail.com"
phonestringrequired
trackingstringrequired
cvinteger(int32)required
Example: 5
qvinteger(int32)required
statusstringrequired
Example: "awaiting_shipment"
order_typestringrequired
Example: "purchased"
ratinginteger(int32)required
reviewstringrequired
Example: "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged."
referrerstringrequired
Example: "Bishal Nepal"
friendly_statusstringrequired
Example: "paid"
typestringrequired
created_atstringrequired
Example: "2023-03-15T11:17:58.289Z"
currency_codestringrequired
Example: "NPR"
currency_symbolstringrequired
Example: "Rs."
display_amountstringrequired
Example: "Rs.16,900.00 (NPR)"
display_subtotalstringrequired
Example: "Rs.12,740.00 (NPR)"
display_taxstringrequired
Example: "Rs.260.00 (NPR)"
display_shippingstringrequired
Example: "Rs.650.00 (NPR)"
display_refundsstringrequired
Example: "(0 CV, 0 QV) -Rs.0.00 (NPR)"
display_discountstringrequired
Example: "Rs.0.00 (NPR)"
order_thumbnailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
sale_datestringrequired
recognized_ship_datestringrequired
Example: "2021-01-02T00:00:00.000Z"
refundablebooleanrequired
Example: true
max_refundable_amountstringrequired
Example: "16900.0"
max_refundable_taxstringrequired
Example: "260.0"
max_refundable_shippingstringrequired
Example: "650.0"
max_refundable_product_pricestringrequired
Example: "12740.0"
display_enrollment_feestringrequired
Example: "Rs.3,250.00 (NPR)"
ship_toobject(ShipTo5)required
Example: {"id":980199006,"name":"Bishal Nepal","address1":"jhapa","address2":null,"address3":null,"city":"damak","state":"Province 1","postal_code":"mechi","country_code":null,"country":{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0,"default":false,"created_at":"2022-05-09T05:12:21.806Z","updated_at":"2022-05-09T05:12:21.806Z","geo_entity_id":28},"default":false}
ship_to.​idinteger(int32)required
Example: 980199006
ship_to.​namestringrequired
Example: "Bishal Nepal"
ship_to.​address1stringrequired
Example: "jhapa"
ship_to.​address2stringrequired
ship_to.​address3stringrequired
ship_to.​citystringrequired
Example: "damak"
ship_to.​statestringrequired
Example: "Province 1"
ship_to.​postal_codestringrequired
Example: "mechi"
ship_to.​country_codestringrequired
ship_to.​countryobject(Country6)required
Example: {"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0,"default":false,"created_at":"2022-05-09T05:12:21.806Z","updated_at":"2022-05-09T05:12:21.806Z","geo_entity_id":28}
ship_to.​country.​idinteger(int32)required
Example: 141
ship_to.​country.​iso_namestringrequired
Example: "NEPAL"
ship_to.​country.​isostringrequired
Example: "NP"
ship_to.​country.​iso3stringrequired
Example: "NPL"
ship_to.​country.​namestringrequired
Example: "Nepal"
ship_to.​country.​numcodeinteger(int32)required
Example: 524
ship_to.​country.​activebooleanrequired
Example: true
ship_to.​country.​currency_codestringrequired
Example: "NPR"
ship_to.​country.​currency_symbolstringrequired
Example: "Rs."
ship_to.​country.​separatorstringrequired
Example: "."
ship_to.​country.​delimiterstringrequired
Example: ","
ship_to.​country.​address3booleanrequired
ship_to.​country.​statebooleanrequired
Example: true
ship_to.​country.​passportbooleanrequired
ship_to.​country.​itnbooleanrequired
ship_to.​country.​tax_rateinteger(int32)required
ship_to.​country.​defaultbooleanrequired
ship_to.​country.​created_atstringrequired
Example: "2022-05-09T05:12:21.806Z"
ship_to.​country.​updated_atstringrequired
Example: "2022-05-09T05:12:21.806Z"
ship_to.​country.​geo_entity_idinteger(int32)required
Example: 28
ship_to.​defaultbooleanrequired
contactobject(Contact)required
Example: {"id":6557,"token":"h59g4H8EExXpmNYmhq4woiMh","first_name":"Bishal","last_name":"Nepal","avatar_url":null,"status":null,"email":"bnepal05579887@gmail.com","email2":null,"phone":null,"phone2":null,"phone_id":null,"address":null,"address2":null,"city":null,"state":null,"postal_code":null,"language_id":null,"country_id":null,"lead_type":null,"ip":null,"requested_at":null,"best_time":null,"time_zone":null,"reason":null,"income":null,"hours":null,"invest":null,"interest":null,"full_name":"Bishal Nepal"}
contact.​idinteger(int32)required
Example: 6557
contact.​tokenstringrequired
Example: "h59g4H8EExXpmNYmhq4woiMh"
contact.​first_namestringrequired
Example: "Bishal"
contact.​last_namestringrequired
Example: "Nepal"
contact.​avatar_urlstringrequired
contact.​statusstringrequired
contact.​emailstringrequired
Example: "bnepal05579887@gmail.com"
contact.​email2stringrequired
contact.​phonestringrequired
contact.​phone2stringrequired
contact.​phone_idstringrequired
contact.​addressstringrequired
contact.​address2stringrequired
contact.​citystringrequired
contact.​statestringrequired
contact.​postal_codestringrequired
contact.​language_idstringrequired
contact.​country_idstringrequired
contact.​lead_typestringrequired
contact.​ipstringrequired
contact.​requested_atstringrequired
contact.​best_timestringrequired
contact.​time_zonestringrequired
contact.​reasonstringrequired
contact.​incomestringrequired
contact.​hoursstringrequired
contact.​investstringrequired
contact.​intereststringrequired
contact.​full_namestringrequired
Example: "Bishal Nepal"
itemsArray of objects(Item3)required
Example: [{"id":8805,"quantity":1,"price":12740,"ordered_variant":"","sku":"sketch12","product":{"id":2240,"active":true,"title":"sketch","description":{"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"},"stripped":"best selling sketch","price":"12740.0","display_price":"Rs.12,740.00 (NPR)","subscription_price":"12740.0","display_subscription_price":"Rs.12,740.00 (NPR)","wholesale_price":"0.0","display_wholesale_price":"Rs.0.00 (NPR)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"Rs.0.00 (NPR)","shipping":"5.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","sku":"sketch","country_code":"ar","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.12,740.00"],"price_range_formatted":"Rs.0.00 - Rs.12,740.00","unlimited_inventory":false,"default_variant":{"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true},"currency_symbol":"Rs.","currency_code":"NPR","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"images":[{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}],"countries":[{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}],"enrolls":[{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]}}]
items[].​idinteger(int32)required
Example: 8803
items[].​quantityinteger(int32)required
Example: 1
items[].​priceinteger(int32)required
Example: 12740
items[].​ordered_variantstringrequired
items[].​skustringrequired
Example: "sketch12"
items[].​productobject(Product10)required
Example: {"id":2240,"active":true,"title":"sketch","description":{"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"},"stripped":"best selling sketch","price":"12740.0","display_price":"Rs.12,740.00 (NPR)","subscription_price":"12740.0","display_subscription_price":"Rs.12,740.00 (NPR)","wholesale_price":"0.0","display_wholesale_price":"Rs.0.00 (NPR)","wholesale_subscription_price":"0.0","display_wholesale_subscription_price":"Rs.0.00 (NPR)","shipping":"5.0","image":{"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","sku":"sketch","country_code":"ar","country_id":null,"views":0,"leads":0,"share_link":null,"commission":"10.0","public":true,"shopify_id":null,"shopify_handle":null,"in_stock":true,"vendor":null,"price_range":["Rs.0.00","Rs.12,740.00"],"price_range_formatted":"Rs.0.00 - Rs.12,740.00","unlimited_inventory":false,"default_variant":{"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true},"currency_symbol":"Rs.","currency_code":"NPR","average_rating":0,"option_values":{},"publish_to_retail_store":true,"publish_to_rep_store":true,"publish_to_share_tab":true,"images":[{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}],"countries":[{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}],"variants":[{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}],"options":[],"prompts":[],"enroll_products":[{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}],"enrolls":[{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]}
items[].​product.​idinteger(int32)required
Example: 2240
items[].​product.​activebooleanrequired
Example: true
items[].​product.​titlestringrequired
Example: "sketch"
items[].​product.​descriptionobject(Description)required
Example: {"id":4836,"name":"description","body":"<div>best selling sketch</div>","record_type":"Product","record_id":2240,"created_at":"2023-02-02T03:48:16.810Z","updated_at":"2023-02-02T03:48:16.810Z"}
items[].​product.​description.​idinteger(int32)required
Example: 4836
items[].​product.​description.​namestringrequired
Example: "description"
items[].​product.​description.​bodystringrequired
Example: "<div>best selling sketch</div>"
items[].​product.​description.​record_typestringrequired
Example: "Product"
items[].​product.​description.​record_idinteger(int32)required
Example: 2240
items[].​product.​description.​created_atstringrequired
Example: "2023-02-02T03:48:16.810Z"
items[].​product.​description.​updated_atstringrequired
Example: "2023-02-02T03:48:16.810Z"
items[].​product.​strippedstringrequired
Example: "best selling sketch"
items[].​product.​pricestringrequired
Example: "12740.0"
items[].​product.​display_pricestringrequired
Example: "Rs.12,740.00 (NPR)"
items[].​product.​subscription_pricestringrequired
Example: "12740.0"
items[].​product.​display_subscription_pricestringrequired
Example: "Rs.12,740.00 (NPR)"
items[].​product.​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_pricestringrequired
Example: "Rs.0.00 (NPR)"
items[].​product.​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​display_wholesale_subscription_pricestringrequired
Example: "Rs.0.00 (NPR)"
items[].​product.​shippingstringrequired
Example: "5.0"
items[].​product.​imageobject(Image3)required
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
items[].​product.​image.​ministringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​detailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image.​fullstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​skustringrequired
Example: "sketch"
items[].​product.​country_codestringrequired
Example: "ar"
items[].​product.​country_idstringrequired
items[].​product.​viewsinteger(int32)required
items[].​product.​leadsinteger(int32)required
items[].​product.​share_linkstringrequired
items[].​product.​commissionstringrequired
Example: "10.0"
items[].​product.​publicbooleanrequired
Example: true
items[].​product.​shopify_idstringrequired
items[].​product.​shopify_handlestringrequired
items[].​product.​in_stockbooleanrequired
Example: true
items[].​product.​vendorstringrequired
items[].​product.​price_rangeArray of stringsrequired
Example: ["Rs.0.00","Rs.12,740.00"]
items[].​product.​price_range_formattedstringrequired
Example: "Rs.0.00 - Rs.12,740.00"
items[].​product.​unlimited_inventorybooleanrequired
items[].​product.​default_variantobject(DefaultVariant3)required
Example: {"id":19630,"product_id":2240,"shopify_id":null,"title":"","sku":"sketch12","position":12698,"inventory_policy":"none","taxable":true,"inventory_quantity":-84,"created_at":"2023-02-02T03:48:18.009Z","updated_at":"2023-09-29T04:59:12.098Z","external_id":null,"variant_country_id":null,"image_url":null,"image_path":null,"is_master":true,"discarded_at":null,"price":null,"weight":"","size":"","physical":true,"unit_of_weight":"lb","height":0,"width":0,"length":0,"unit_of_size":"ft","hs_code":"","country_of_origin":"","customs_information_shipping":false,"active":true,"bar_code":"","track_quantity":false,"keep_selling":true,"option_attrs":[],"allow_subscription":true}
items[].​product.​default_variant.​idinteger(int32)required
Example: 19630
items[].​product.​default_variant.​product_idinteger(int32)required
Example: 2240
items[].​product.​default_variant.​shopify_idstringrequired
items[].​product.​default_variant.​titlestringrequired
items[].​product.​default_variant.​skustringrequired
Example: "sketch12"
items[].​product.​default_variant.​positioninteger(int32)required
Example: 12698
items[].​product.​default_variant.​inventory_policystringrequired
Example: "none"
items[].​product.​default_variant.​taxablebooleanrequired
Example: true
items[].​product.​default_variant.​inventory_quantityinteger(int32)required
Example: -84
items[].​product.​default_variant.​created_atstringrequired
Example: "2023-02-02T03:48:18.009Z"
items[].​product.​default_variant.​updated_atstringrequired
Example: "2023-09-29T04:59:12.098Z"
items[].​product.​default_variant.​external_idstringrequired
items[].​product.​default_variant.​variant_country_idstringrequired
items[].​product.​default_variant.​image_urlstringrequired
items[].​product.​default_variant.​image_pathstringrequired
items[].​product.​default_variant.​is_masterbooleanrequired
Example: true
items[].​product.​default_variant.​discarded_atstringrequired
items[].​product.​default_variant.​pricestringrequired
items[].​product.​default_variant.​weightstringrequired
items[].​product.​default_variant.​sizestringrequired
items[].​product.​default_variant.​physicalbooleanrequired
Example: true
items[].​product.​default_variant.​unit_of_weightstringrequired
Example: "lb"
items[].​product.​default_variant.​heightinteger(int32)required
items[].​product.​default_variant.​widthinteger(int32)required
items[].​product.​default_variant.​lengthinteger(int32)required
items[].​product.​default_variant.​unit_of_sizestringrequired
Example: "ft"
items[].​product.​default_variant.​hs_codestringrequired
items[].​product.​default_variant.​country_of_originstringrequired
items[].​product.​default_variant.​customs_information_shippingbooleanrequired
items[].​product.​default_variant.​activebooleanrequired
Example: true
items[].​product.​default_variant.​bar_codestringrequired
items[].​product.​default_variant.​track_quantitybooleanrequired
items[].​product.​default_variant.​keep_sellingbooleanrequired
Example: true
items[].​product.​default_variant.​option_attrsArray of stringsrequired
Example: []
items[].​product.​default_variant.​allow_subscriptionbooleanrequired
Example: true
items[].​product.​currency_symbolstringrequired
Example: "Rs."
items[].​product.​currency_codestringrequired
Example: "NPR"
items[].​product.​average_ratinginteger(int32)required
items[].​product.​option_valuesobjectrequired
Example: {}
items[].​product.​publish_to_retail_storebooleanrequired
Example: true
items[].​product.​publish_to_rep_storebooleanrequired
Example: true
items[].​product.​publish_to_share_tabbooleanrequired
Example: true
items[].​product.​imagesArray of objects(Image9)required
Example: [{"id":2089,"image":{"mini":"https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"},"image_url":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","position":null,"shopify_id":null}]
items[].​product.​images[].​idinteger(int32)required
Example: 2089
items[].​product.​images[].​imageobject(Image3)required
Example: {"mini":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","detail":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg","full":"https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"}
items[].​product.​images[].​image.​ministringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​image.​detailstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​image.​fullstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​image_urlstringrequired
Example: "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg"
items[].​product.​images[].​positionstringrequired
items[].​product.​images[].​shopify_idstringrequired
items[].​product.​countriesArray of objects(Country7)required
Example: [{"id":27,"iso_name":"BOTSWANA","iso":"BW","iso3":"BWA","name":"Botswana","numcode":72,"active":true,"currency_code":"BWP","currency_symbol":"P","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":68,"iso_name":"FRANCE","iso":"FR","iso3":"FRA","name":"France","numcode":250,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":214,"iso_name":"UNITED STATES","iso":"US","iso3":"USA","name":"United States","numcode":840,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":12,"iso_name":"AUSTRALIA","iso":"AU","iso3":"AUS","name":"Australia","numcode":36,"active":true,"currency_code":"AUD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":13,"iso_name":"AUSTRIA","iso":"AT","iso3":"AUT","name":"Austria","numcode":40,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":14,"iso_name":"AZERBAIJAN","iso":"AZ","iso3":"AZE","name":"Azerbaijan","numcode":31,"active":true,"currency_code":"AZN","currency_symbol":"₼","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":15,"iso_name":"BAHAMAS","iso":"BS","iso3":"BHS","name":"Bahamas","numcode":44,"active":true,"currency_code":"BSD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":16,"iso_name":"BAHRAIN","iso":"BH","iso3":"BHR","name":"Bahrain","numcode":48,"active":true,"currency_code":"BHD","currency_symbol":"د.ب","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":17,"iso_name":"BANGLADESH","iso":"BD","iso3":"BGD","name":"Bangladesh","numcode":50,"active":true,"currency_code":"BDT","currency_symbol":"৳","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":41,"iso_name":"CHINA","iso":"CN","iso3":"CHN","name":"China","numcode":156,"active":true,"currency_code":"CNY","currency_symbol":"¥","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":162,"iso_name":"POLAND","iso":"PL","iso3":"POL","name":"Poland","numcode":616,"active":true,"currency_code":"PLN","currency_symbol":"zł","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":163,"iso_name":"PORTUGAL","iso":"PT","iso3":"PRT","name":"Portugal","numcode":620,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":168,"iso_name":"RUSSIAN FEDERATION","iso":"RU","iso3":"RUS","name":"Russia","numcode":643,"active":true,"currency_code":"RUB","currency_symbol":"₽","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":197,"iso_name":"TAIWAN, PROVINCE OF CHINA","iso":"TW","iso3":"TWN","name":"Taiwan","numcode":158,"active":true,"currency_code":"TWD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":2,"iso_name":"ALBANIA","iso":"AL","iso3":"ALB","name":"Albania","numcode":8,"active":true,"currency_code":"ALL","currency_symbol":"L","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":3,"iso_name":"ALGERIA","iso":"DZ","iso3":"DZA","name":"Algeria","numcode":12,"active":true,"currency_code":"DZD","currency_symbol":"د.ج","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":74,"iso_name":"GERMANY","iso":"DE","iso3":"DEU","name":"Germany","numcode":276,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":141,"iso_name":"NEPAL","iso":"NP","iso3":"NPL","name":"Nepal","numcode":524,"active":true,"currency_code":"NPR","currency_symbol":"Rs.","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":188,"iso_name":"SPAIN","iso":"ES","iso3":"ESP","name":"Spain","numcode":724,"active":true,"currency_code":"EUR","currency_symbol":"€","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":1,"iso_name":"AFGHANISTAN","iso":"AF","iso3":"AFG","name":"Afghanistan","numcode":4,"active":true,"currency_code":"AFN","currency_symbol":"؋","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":4,"iso_name":"AMERICAN SAMOA","iso":"AS","iso3":"ASM","name":"American Samoa","numcode":16,"active":true,"currency_code":"USD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":9,"iso_name":"ARGENTINA","iso":"AR","iso3":"ARG","name":"Argentina","numcode":32,"active":true,"currency_code":"ARS","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0},{"id":23,"iso_name":"BERMUDA","iso":"BM","iso3":"BMU","name":"Bermuda","numcode":60,"active":true,"currency_code":"BMD","currency_symbol":"$","separator":".","delimiter":",","address3":false,"state":true,"passport":false,"itn":false,"tax_rate":0}]
items[].​product.​countries[].​idinteger(int32)required
Example: 27
items[].​product.​countries[].​iso_namestringrequired
Example: "BOTSWANA"
items[].​product.​countries[].​isostringrequired
Example: "BW"
items[].​product.​countries[].​iso3stringrequired
Example: "BWA"
items[].​product.​countries[].​namestringrequired
Example: "Botswana"
items[].​product.​countries[].​numcodeinteger(int32)required
Example: 72
items[].​product.​countries[].​activebooleanrequired
Example: true
items[].​product.​countries[].​currency_codestringrequired
Example: "BWP"
items[].​product.​countries[].​currency_symbolstringrequired
Example: "P"
items[].​product.​countries[].​separatorstringrequired
Example: "."
items[].​product.​countries[].​delimiterstringrequired
Example: ","
items[].​product.​countries[].​address3booleanrequired
items[].​product.​countries[].​statebooleanrequired
Example: true
items[].​product.​countries[].​passportbooleanrequired
items[].​product.​countries[].​itnbooleanrequired
items[].​product.​countries[].​tax_rateinteger(int32)required
items[].​product.​variantsArray of objects(Variant9)required
Example: [{"id":19630,"title":"","image_url":null,"buyable":true,"option_value_ids":[],"allow_subscription":true,"variant_countries":[{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]}]
items[].​product.​variants[].​idinteger(int32)required
Example: 19630
items[].​product.​variants[].​titlestringrequired
items[].​product.​variants[].​image_urlstringrequired
items[].​product.​variants[].​buyablebooleanrequired
Example: true
items[].​product.​variants[].​option_value_idsArray of stringsrequired
Example: []
items[].​product.​variants[].​allow_subscriptionbooleanrequired
Example: true
items[].​product.​variants[].​variant_countriesArray of objects(VariantCountries5)required
Example: [{"id":130789,"price":"9800.0","shipping":"500.0","tax":"200.0","currency_code":"ARS","currency_symbol":"$","display_price":"$9,800.00 (ARS)","country_iso":"AR","subscription_price":"9800.0","display_wholesale_price":"$0.00 (ARS)","display_wholesale_subscription_price":"$0.00 (ARS)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}},{"id":130790,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"AUD","currency_symbol":"$","display_price":"$98.00 (AUD)","country_iso":"AU","subscription_price":"98.0","display_wholesale_price":"$0.00 (AUD)","display_wholesale_subscription_price":"$0.00 (AUD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":12,"iso":"AU","iso_name":"AUSTRALIA","iso3":"AUS","name":"Australia","tax_rate":0}},{"id":130791,"price":"4900.0","shipping":"250.0","tax":"100.0","currency_code":"EUR","currency_symbol":"€","display_price":"€4,900.00 (EUR)","country_iso":"AT","subscription_price":"4900.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":13,"iso":"AT","iso_name":"AUSTRIA","iso3":"AUT","name":"Austria","tax_rate":0}},{"id":130792,"price":"9604.0","shipping":"490.0","tax":"196.0","currency_code":"AZN","currency_symbol":"₼","display_price":"₼9,604.00 (AZN)","country_iso":"AZ","subscription_price":"9604.0","display_wholesale_price":"₼0.00 (AZN)","display_wholesale_subscription_price":"₼0.00 (AZN)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":14,"iso":"AZ","iso_name":"AZERBAIJAN","iso3":"AZE","name":"Azerbaijan","tax_rate":0}},{"id":130793,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BSD","currency_symbol":"$","display_price":"$98.00 (BSD)","country_iso":"BS","subscription_price":"98.0","display_wholesale_price":"$0.00 (BSD)","display_wholesale_subscription_price":"$0.00 (BSD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":15,"iso":"BS","iso_name":"BAHAMAS","iso3":"BHS","name":"Bahamas","tax_rate":0}},{"id":130794,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BHD","currency_symbol":"د.ب","display_price":"د.ب98.000 (BHD)","country_iso":"BH","subscription_price":"98.0","display_wholesale_price":"د.ب0.000 (BHD)","display_wholesale_subscription_price":"د.ب0.000 (BHD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":16,"iso":"BH","iso_name":"BAHRAIN","iso3":"BHR","name":"Bahrain","tax_rate":0}},{"id":130795,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BDT","currency_symbol":"৳","display_price":"৳98.00 (BDT)","country_iso":"BD","subscription_price":"98.0","display_wholesale_price":"৳0.00 (BDT)","display_wholesale_subscription_price":"৳0.00 (BDT)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":17,"iso":"BD","iso_name":"BANGLADESH","iso3":"BGD","name":"Bangladesh","tax_rate":0}},{"id":130798,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BMD","currency_symbol":"$","display_price":"$98.00 (BMD)","country_iso":"BM","subscription_price":"98.0","display_wholesale_price":"$0.00 (BMD)","display_wholesale_subscription_price":"$0.00 (BMD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":23,"iso":"BM","iso_name":"BERMUDA","iso3":"BMU","name":"Bermuda","tax_rate":0}},{"id":130801,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"BWP","currency_symbol":"P","display_price":"P98.00 (BWP)","country_iso":"BW","subscription_price":"98.0","display_wholesale_price":"P0.00 (BWP)","display_wholesale_subscription_price":"P0.00 (BWP)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":27,"iso":"BW","iso_name":"BOTSWANA","iso3":"BWA","name":"Botswana","tax_rate":0}},{"id":130881,"price":"12740.0","shipping":"650.0","tax":"260.0","currency_code":"NPR","currency_symbol":"Rs.","display_price":"Rs.12,740.00 (NPR)","country_iso":"NP","subscription_price":"12740.0","display_wholesale_price":"Rs.0.00 (NPR)","display_wholesale_subscription_price":"Rs.0.00 (NPR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":141,"iso":"NP","iso_name":"NEPAL","iso3":"NPL","name":"Nepal","tax_rate":0}},{"id":130897,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"EUR","currency_symbol":"€","display_price":"€98.00 (EUR)","country_iso":"PT","subscription_price":"98.0","display_wholesale_price":"€0.00 (EUR)","display_wholesale_subscription_price":"€0.00 (EUR)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":163,"iso":"PT","iso_name":"PORTUGAL","iso3":"PRT","name":"Portugal","tax_rate":0}},{"id":130921,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"TWD","currency_symbol":"$","display_price":"$98.00 (TWD)","country_iso":"TW","subscription_price":"98.0","display_wholesale_price":"$0.00 (TWD)","display_wholesale_subscription_price":"$0.00 (TWD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":197,"iso":"TW","iso_name":"TAIWAN, PROVINCE OF CHINA","iso3":"TWN","name":"Taiwan","tax_rate":0}},{"id":130933,"price":"98.0","shipping":"5.0","tax":"2.0","currency_code":"USD","currency_symbol":"$","display_price":"$98.00 (USD)","country_iso":"US","subscription_price":"98.0","display_wholesale_price":"$0.00 (USD)","display_wholesale_subscription_price":"$0.00 (USD)","wholesale_price":"0.0","wholesale_subscription_price":"0.0","country":{"id":214,"iso":"US","iso_name":"UNITED STATES","iso3":"USA","name":"United States","tax_rate":0}}]
items[].​product.​variants[].​variant_countries[].​idinteger(int32)required
Example: 130789
items[].​product.​variants[].​variant_countries[].​pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​shippingstringrequired
Example: "500.0"
items[].​product.​variants[].​variant_countries[].​taxstringrequired
Example: "200.0"
items[].​product.​variants[].​variant_countries[].​currency_codestringrequired
Example: "ARS"
items[].​product.​variants[].​variant_countries[].​currency_symbolstringrequired
Example: "$"
items[].​product.​variants[].​variant_countries[].​display_pricestringrequired
Example: "$9,800.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​country_isostringrequired
Example: "AR"
items[].​product.​variants[].​variant_countries[].​subscription_pricestringrequired
Example: "9800.0"
items[].​product.​variants[].​variant_countries[].​display_wholesale_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​display_wholesale_subscription_pricestringrequired
Example: "$0.00 (ARS)"
items[].​product.​variants[].​variant_countries[].​wholesale_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​wholesale_subscription_pricestringrequired
Example: "0.0"
items[].​product.​variants[].​variant_countries[].​countryobject(Country8)required
Example: {"id":9,"iso":"AR","iso_name":"ARGENTINA","iso3":"ARG","name":"Argentina","tax_rate":0}
items[].​product.​optionsArray of stringsrequired
Example: []
items[].​product.​promptsArray of stringsrequired
Example: []
items[].​product.​enroll_productsArray of objects(EnrollProduct2)required
Example: [{"id":19,"product_id":2240,"enroll_id":2,"active":true,"type":"membership_product","created_at":"2023-02-15T06:40:53.303Z","updated_at":"2023-02-15T06:40:53.303Z"}]
items[].​product.​enroll_products[].​idinteger(int32)required
Example: 19
items[].​product.​enroll_products[].​product_idinteger(int32)required
Example: 2240
items[].​product.​enroll_products[].​enroll_idinteger(int32)required
Example: 2
items[].​product.​enroll_products[].​activebooleanrequired
Example: true
items[].​product.​enroll_products[].​typestringrequired
Example: "membership_product"
items[].​product.​enroll_products[].​created_atstringrequired
Example: "2023-02-15T06:40:53.303Z"
items[].​product.​enroll_products[].​updated_atstringrequired
Example: "2023-02-15T06:40:53.303Z"
items[].​product.​enrollsArray of objects(Enroll2)required
Example: [{"id":2,"integration_id":null,"fields":{"dob":"Birthdate","full_name":"Name","government_id":"Government ID"},"member_fee":25,"member_fee_enabled":true,"company_id":980191019,"created_at":"2023-02-01T07:49:12.347Z","updated_at":"2023-02-01T07:54:36.961Z","terms_and_conditions_url":"https://www.google.com/"}]
items[].​product.​enrolls[].​idinteger(int32)required
Example: 2
items[].​product.​enrolls[].​integration_idstringrequired
items[].​product.​enrolls[].​fieldsobject(Fields)required
Example: {"dob":"Birthdate","full_name":"Name","government_id":"Government ID"}
items[].​product.​enrolls[].​fields.​dobstringrequired
Example: "Birthdate"
items[].​product.​enrolls[].​fields.​full_namestringrequired
Example: "Name"
items[].​product.​enrolls[].​fields.​government_idstringrequired
Example: "Government ID"
items[].​product.​enrolls[].​member_feeinteger(int32)required
Example: 25
items[].​product.​enrolls[].​member_fee_enabledbooleanrequired
Example: true
items[].​product.​enrolls[].​company_idinteger(int32)required
Example: 980191019
items[].​product.​enrolls[].​created_atstringrequired
Example: "2023-02-01T07:49:12.347Z"
items[].​product.​enrolls[].​updated_atstringrequired
Example: "2023-02-01T07:54:36.961Z"
items[].​product.​enrolls[].​terms_and_conditions_urlstringrequired
Example: "https://www.google.com/"
tracking_informationsArray of stringsrequired
Example: []
Response
application/json; charset=utf-8
{
  "id": 8770,
  "order_number": "F32835649011346",
  "amount": "16900.0",
  "shipping": "650.0",
  "tax": "260.0",
  "subtotal": "12740.0",
  "first_name": "Bishal",
  "last_name": "Nepal",
  "email": "bnepal05362914@gmail.com",
  "phone": null,
  "tracking": null,
  "cv": 5,
  "qv": 0,
  "status": "awaiting_shipment",
  "order_type": "purchased",
  "rating": 0,
  "review": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.",
  "referrer": "Bishal Nepal",
  "friendly_status": "paid",
  "type": null,
  "created_at": "2023-03-15T11:17:58.289Z",
  "currency_code": "NPR",
  "currency_symbol": "Rs.",
  "display_amount": "Rs.16,900.00 (NPR)",
  "display_subtotal": "Rs.12,740.00 (NPR)",
  "display_tax": "Rs.260.00 (NPR)",
  "display_shipping": "Rs.650.00 (NPR)",
  "display_refunds": "(0 CV, 0 QV) -Rs.0.00 (NPR)",
  "display_discount": "Rs.0.00 (NPR)",
  "order_thumbnail": "https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg",
  "sale_date": null,
  "recognized_ship_date": "2021-01-02T00:00:00.000Z",
  "refundable": true,
  "max_refundable_amount": "16900.0",
  "max_refundable_tax": "260.0",
  "max_refundable_shipping": "650.0",
  "max_refundable_product_price": "12740.0",
  "display_enrollment_fee": "Rs.3,250.00 (NPR)",
  "ship_to": {
    "id": 980199006,
    "name": "Bishal Nepal",
    "address1": "jhapa",
    "address2": null,
    "address3": null,
    "city": "damak",
    "state": "Province 1",
    "postal_code": "mechi",
    "country_code": null,
    "country": { … },
    "default": false
  },
  "contact": {
    "id": 6559,
    "token": "SGJ8gug1WYDBB4vhNW5DqoMM",
    "first_name": "Bishal",
    "last_name": "Nepal",
    "avatar_url": null,
    "status": null,
    "email": "bnepal05362914@gmail.com",
    "email2": null,
    "phone": null,
    "phone2": null,
    "phone_id": null,
    "address": null,
    "address2": null,
    "city": null,
    "state": null,
    "postal_code": null,
    "language_id": null,
    "country_id": null,
    "lead_type": null,
    "ip": null,
    "requested_at": null,
    "best_time": null,
    "time_zone": null,
    "reason": null,
    "income": null,
    "hours": null,
    "invest": null,
    "interest": null,
    "full_name": "Bishal Nepal"
  },
  "items": [
    { … }
  ],
  "tracking_informations": []
}

Delete Company Order

Request

Deletes a specific order belonging to a company.

Path
orderIdintegerrequired

The unique identifier of the order to delete

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/orders/{orderId}.json'

Responses

OK

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"
Bodyapplication/json; charset=utf-8
string
Response
application/json; charset=utf-8
"Order deleted successfully."

Retrieves an order with points redemption

Request

Path
tokenstringrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/public/v2025-06/orders/{token}'

Responses

order with points found

Bodyapplication/json
orderobjectrequired
order.​idintegerrequired
order.​amount_in_basestring
Example: "10.0"
order.​base_to_currency_ratestring or null
Example: "1.35"
order.​currency_symbolstringrequired
order.​currency_codestring
order.​external_idstring or null
order.​order_numberstring
order.​notestring or null
order.​company_logo_urlstring or null
order.​created_atstring
order.​customerstring or null
order.​emailstring or null
order.​totalstringrequired
order.​total_in_currencystring
order.​subtotalstring
Example: "90.00"
order.​sub_totalstring
Example: "90.00"
order.​sub_total_in_currencystring
Example: "$90.00"
order.​subtotal_after_discountsstring
Example: "90.00"
order.​taxstring
Example: "2.00"
order.​tax_in_currencystring
Example: "$2.00"
order.​tokenstring
Example: "fo_abcdefgh1234"
order.​transaction_feestring
Example: "1.00"
order.​transaction_fee_in_currencystring
Example: "$1.00"
order.​discountstring
Example: "3.00"
order.​discount_in_currencystring
Example: "$3.00"
order.​refundable_amountnumber or string(float)
Example: 10.5
order.​shippingstring
Example: "$11.00"
order.​shipping_in_currencyobject or null
order.​payment_statusstringrequired
order.​enrollment_tokenstring or null
order.​enrollment_packobject or null
order.​fulfillment_statusstringrequired
order.​order_statusstring
order.​financial_statusstring
order.​delivery_statusstringrequired
order.​delivery_methodstringrequired
order.​delivery_datestring or null
Example: "2023-07-29"
order.​channelstringrequired
order.​tagsstringrequired
order.​items_countintegerrequired
order.​quantity_countinteger
order.​itemsArray of objectsrequired
order.​items[].​idinteger
Example: 101
order.​items[].​pricenumber or string
Example: 43.41
order.​items[].​price_in_currencystring
Example: "$43.41"
order.​items[].​taxstring
Example: "2.99"
order.​items[].​tax_in_currencystring
Example: "$2.99"
order.​items[].​cvinteger
Example: 5
order.​items[].​cv_in_currencystring
Example: "$5.00"
order.​items[].​qvinteger
Example: 7
order.​items[].​qv_in_currencystring
Example: "$7.00"
order.​items[].​product_titlestring
Example: "Sample Product"
order.​items[].​variant_titlestring or null
Example: "Sample Variant"
order.​items[].​variant_imagestring or null
Example: "https://example.com/image.png"
order.​items[].​variant_idinteger
Example: 202
order.​items[].​quantityinteger
Example: 3
order.​items[].​titlestring
order.​items[].​totalnumber or string
order.​items[].​image_urlstring or null
order.​items[].​skustring or null
order.​items[].​display_pricestring
order.​items[].​display_totalstring
order.​items[].​refundable_amountnumber or string(float)
Example: 10.5
order.​items[].​enrollment_pack_idinteger or null
order.​items[].​display_to_customerboolean or null
Example: true
order.​items[].​bundled_itemsArray of objects
order.​items[].​ordered_variantArray of objects
order.​items[].​productobject
order.​items[].​variantobject
order.​activitiesArray of objects
order.​shipping_methodobject or null
order.​payment_detailsobject or nullrequired
order.​payment_details.​sourcestring
Example: "card"
order.​payment_details.​payment_typestring
order.​payment_details.​payment_titlestring
order.​payment_details.​detailsobject
order.​primary_domain_hostnamestring or null
Example: "fluid.com"
order.​company_subdomainstring or null
Example: "myco"
order.​shipping_totalstring
Example: "0.0"
order.​shipping_total_for_displaystring
Example: "Free"
order.​ship_toobjectrequired
order.​ship_to.​idinteger
Example: 1
order.​ship_to.​namestring or null
Example: "John Doe"
order.​ship_to.​first_namestring or null
Example: "John"
order.​ship_to.​last_namestring or null
Example: "Doe"
order.​ship_to.​address1string
Example: "123 Main St"
order.​ship_to.​address2string or null
Example: "Apt 4B"
order.​ship_to.​address3string or null
Example: "Building 5"
order.​ship_to.​citystring
Example: "New York"
order.​ship_to.​statestring
Example: "NY"
order.​ship_to.​postal_codestring
Example: "10001"
order.​ship_to.​country_codestring

country_id takes precedence if both country_id and country_code provided.

Example: "US"
order.​ship_to.​subdivision_codestring or null
Example: "NY"
order.​ship_to.​defaultboolean
Example: true
order.​bill_toobject
order.​shipping_addressobject or null
order.​billing_addressobject or null
order.​warehouse_idinteger or null
Example: 1
order.​warehouseWarehouse (object) or null
One of:
order.​companyobject
order.​order_on_behalf_ofboolean
Example: true
order.​volume_repobject or null
order.​metadataobject or null
order.​metafieldsArray of objects(LegacyMetafield)
order.​sourcestring
Enum"mobile""web""admin""backoffice""subscription"
Example: "web"
order.​split_paymentobject or null

Details about split payment if points were used

order.​points_appliedinteger

Total points used for this order

Example: 500
order.​points_applied_amount_in_currencynumber

Total points in currency amount used for this order

Example: 5
order.​order_total_after_points_redemptionnumber

The order total (actual card payment) after points redemption

Example: 95
order.​price_inclusive_of_taxboolean

Whether the price includes tax

Example: true
order.​price_inclusive_tax_namestring or null

Name of the tax if price is inclusive, e.g. VAT, GST

Example: "GST"
order.​free_shippingboolean

Whether the order has free shipping

Example: false
order.​discount_codesArray of strings

Discount codes applied to the order

Example: ["DISCOUNT1","DISCOUNT2"]
metaobjectrequired
meta.​request_idstring
meta.​timestampstring
meta.​shop_urlstring
Response
application/json
{
  "order": {
    "id": 0,
    "amount_in_base": "10.0",
    "base_to_currency_rate": "1.35",
    "currency_symbol": "string",
    "currency_code": "string",
    "external_id": "string",
    "order_number": "string",
    "note": "string",
    "company_logo_url": "string",
    "created_at": "string",
    "customer": "string",
    "email": "string",
    "total": "string",
    "total_in_currency": "string",
    "subtotal": "90.00",
    "sub_total": "90.00",
    "sub_total_in_currency": "$90.00",
    "subtotal_after_discounts": "90.00",
    "tax": "2.00",
    "tax_in_currency": "$2.00",
    "token": "fo_abcdefgh1234",
    "transaction_fee": "1.00",
    "transaction_fee_in_currency": "$1.00",
    "discount": "3.00",
    "discount_in_currency": "$3.00",
    "refundable_amount": 10.5,
    "shipping": "$11.00",
    "shipping_in_currency": { … },
    "payment_status": "string",
    "enrollment_token": "string",
    "enrollment_pack": { … },
    "fulfillment_status": "string",
    "order_status": "string",
    "financial_status": "string",
    "delivery_status": "string",
    "delivery_method": "string",
    "delivery_date": "2023-07-29",
    "channel": "string",
    "tags": "string",
    "items_count": 0,
    "quantity_count": 0,
    "items": [ … ],
    "activities": [ … ],
    "shipping_method": { … },
    "payment_details": { … },
    "primary_domain_hostname": "fluid.com",
    "company_subdomain": "myco",
    "shipping_total": "0.0",
    "shipping_total_for_display": "Free",
    "ship_to": { … },
    "bill_to": { … },
    "shipping_address": { … },
    "billing_address": { … },
    "warehouse_id": 1,
    "warehouse": { … },
    "company": { … },
    "order_on_behalf_of": true,
    "volume_rep": { … },
    "metadata": {},
    "metafields": [ … ],
    "source": "web",
    "split_payment": {},
    "points_applied": 500,
    "points_applied_amount_in_currency": 5,
    "order_total_after_points_redemption": 95,
    "price_inclusive_of_tax": true,
    "price_inclusive_tax_name": "GST",
    "free_shipping": false,
    "discount_codes": [ … ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "string",
    "shop_url": "string"
  }
}

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Points

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Product Bundles

Operations

Product Images

Operations

Product Subscription Plans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Recipients

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tiles

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variant Images

Operations

Variant Inventory Levels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations