eComerce System APiDoc

Store

PUT /contact-us

Headers

Parameters

Name	Type	Required	Description
scenario	int	Yes	Scenario Name, 1 - default, 2 - ecommerce (used by default
name	string	Yes	Customer Name
email	string	Yes	Customer Email
phone	string	Yes	Phone Email, required for Scenario 1
subject	string	Yes	Subjects, possible for use: 'Cancel order', 'Change my billing address', 'Change my email address', 'Change my order', 'Change my privacy settings', 'Change my shipping address', 'Change my shipping method', 'Damaged Item', 'Delivery options', 'Missing Item', 'Not Satisfied', 'Problems at checkout', 'Question about an item', 'Technical Issues', 'Track my order', 'Wrong Item', 'Other'
body	string	Yes	Content
ordernumber	string	Yes	Order Number
message	string	Yes	Message
reCaptcha	string	Yes	Captcha token

Body

Headers

Response

HTTP 200 Ok

{
  'name': '[string]',
  'email': '[string]',
  'ordernumber': '[string]',
  'subject': '[string]',
  'body': '[string]'
 }

GET /search

Search Products|Pages|Blogs

Headers

Parameters

Name	Type	Required	Description
search	string	Yes	Search String
page	integer	Yes	Page Items
per-page	integer	Yes	Per Page Items
type	string	No	One of ['pages', 'products', 'blogs']. If not set returned all types.

Body

Headers

Response

HTTP 200 Ok

{
  'products': {
      'items': [],
      '_links': {
          'self': {
              'href': '[string]'
          },
          'first': {
              'href': '[string]'
          },
          'prev': {
              'href': '[string]'
          },
          'next': {
              'href': '[string]'
          },
          'last': {
              'href': '[string]'
          }
      },
      '_meta': {
          'totalCount': '[integer]',
          'pageCount': '[integer]',
          'currentPage':'[integer]',
          'perPage': '[integer]'
      }
  },
  'pages': {
      'items': [],
      '_links': {
          'self': {
              'href': '[string]'
          },
          'first': {
              'href': '[string]'
          },
          'prev': {
              'href': '[string]'
          },
          'next': {
              'href': '[string]'
          },
          'last': {
              'href': '[string]'
          }
      },
      '_meta': {
          'totalCount': '[integer]',
          'pageCount': '[integer]',
          'currentPage':'[integer]',
          'perPage': '[integer]'
      }
  },
  'blog_posts': {
      'items': [],
      '_links': {
          'self': {
              'href': '[string]'
          },
          'first': {
              'href': '[string]'
          },
          'prev': {
              'href': '[string]'
          },
          'next': {
              'href': '[string]'
          },
          'last': {
              'href': '[string]'
          }
      },
      '_meta': {
          'totalCount': '[integer]',
          'pageCount': '[integer]',
          'currentPage':'[integer]',
          'perPage': '[integer]'
      }
  },
  'noResults': '[bool]',
  'search': '[string]'
 }

GET /options

Get Store Options

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{}

POST /influencer

Save Influencer Details

Headers

Parameters

Name	Type	Required	Description
name	string	Yes	Influencer name
location	string	Yes	Influencer location
age	integer	Yes	Influencer age
phone	integer	Yes	Influencer phone
email	string	Yes	Influencer email
why_interested	string	Yes	Influencer interest
how_relate	string	Yes	how relate
content_style	string	Yes	content style
personality	string	Yes	personality
location_of_audience	string	Yes	location of audience
social_reach	string	Yes	social reach
social_reach_file[]	multi_file	Yes	social reach file
instagram	string	Yes	instagram
facebook	string	Yes	facebook
youtube	string	Yes	youtube
blog	string	Yes	blog
snapchat	string	Yes	snapchat
twitter	string	Yes	twitter
pinterest	string	Yes	pinterest
partnerships	string	Yes	partnerships
step	string	Yes	step must be: 1 or 2 or or 'submit', step 'submit' must be sent as last step and all form data

Body

Headers

Response

HTTP 204 Ok

POST /job-apply

Save Job Apply Request

Headers

Parameters

Name	Type	Required	Description
token	string	No	ID
name	string	No	Full Name
email	string	No	Email
phone	integer	No	Phone
age	integer	No	Age
questions[experience]	string	No	Experience
questions[sales_experience]	string	No	Sales Experience
questions[tertiary_education]	string	No	Tertiary Education
questions[job_career]	string	No	Job Career
cv	file	No	CV
step	string	Yes	step must be: 1 or 2 ... or Last

Body

Headers

Response

HTTP 204 Ok

{
      'name': '[string]',
      'email': '[string]',
      'phone': '[string]',
      'age': '[integer]',
      'questions': '[array]',
      'step': '[string]',
      'token': '[string]',
      'file_url': '[string]',
      'updated_at': '[string]',
      'created_at': '[string]'

 }

GET /translates

Get Store Languages Translates

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{}

GET /languages

Get Store Languages List

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{}

PUT /report-scam

Report Scam

Headers

Parameters

Name	Type	Required	Description
name	string	Yes	Customer Name (220 Chars
email	string	Yes	Customer Email (220 Chars
phone	string	Yes	Customer Phone
website	string	Yes	Customer Website
description	string	Yes	Description (1000 Chars

Body

Headers

Response

HTTP 200 Ok

{
  'name': '[string]',
  'email': '[string]',
  'phone': '[string]',
  'website': '[string]',
  'description': '[string]'
 }

GET /{first}/{second}/{third}

Headers

Parameters

Name	Type	Required
first	string	Yes
second	string	No
third	string	No

Body

Headers

Response

HTTP 200 Ok

{
  'type': '[string]',
  'object': '[object]'
 }

Authentication

POST /auth/login

Headers

Parameters

Name	Type	Required	Description
email	string	Yes	Customer Email
password	string	Yes	Customer Password
ip	string	No	Customer Ip
remember_me	boolean	No	Remember customer after login, default TRUE
skip_cart_merge	boolean	No	Mark as TRUE if need to do cart merge after login, default FALSE
checkout_token	string	No	Checkout token, use for login on checkout page

Body

Headers

Response

HTTP 200 Ok

{
   'auth_key': '[string]',
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

POST /auth/logout

Logout Customer From System [auth]

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{
   'need_create_checkout': '[boolean]'
 }

POST /auth/signup

Headers

Parameters

Name	Type	Required	Description
username	string	Yes	Customer User Name, ex John King
email	string	Yes	Customer Email
password	string	Yes	Customer Password, check if need submit this field by GET /settings/customer-password if returns TRUE then password is not required and will be generated automatically
subscribe	boolean	Yes	1- Subscribe, 0 - not, by default is 1 (True
time_zone	string	No	Customer Time Zone, if submit wrong time zone then will be used App default time zone
country	string	No	Customer Detected Country
skip_cart_merge	boolean	No	Mark as TRUE if need to do cart merge after sign up, default FALSE
checkout_token	string	No	Checkout token, use for sign up on checkout page, if wrong checkout token then it will be ignored
identity	string	No	Customer identity
invited_by_token	string	No	Customer invited by token, if token is wrong then invitation will be ignored

Body

Headers

Response

HTTP 200 Ok

{
   'auth_key': '[string]',
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

POST /auth/uuid

Headers

Parameters

Name	Type	Required	Description
uuid	string	Yes	Customer Uuid

Body

Headers

Response

HTTP 200 Ok

{
   'auth_key': '[string]',
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

POST /auth/password-reset-token

Headers

Parameters

Name	Type	Required	Description
password_reset_token	string	Yes	Customer password reset token

Body

Headers

Response

HTTP 200 Ok

{
   'auth_key': '[string]',
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

POST /auth/facebook

Headers

Parameters

Name	Type	Required	Description
token	string	Yes	Facebook Token which you get by FB.js, for testing you can visit page FB Graph API Explorer and grab your user token
subscribe	boolean	Yes	1- Subscribe, 0 - not, by default is 1 (True
time_zone	string	No	Customer Time Zone, if submit wrong time zone then will be used App default time zone
country	string	No	Customer Detected Country
skip_cart_merge	boolean	No	Mark as TRUE if need to do cart merge after sign up, default FALSE
checkout_token	string	No	Checkout token, use for sign up on checkout page, if wrong checkout token then it will show error
identity	string	No	Customer identity
invited_by_token	string	No	Customer invited by token, if token is wrong then invitation will be ignored
email	string	No	Customer Email, in case when FB does not return email
password	string	No	Customer Password for provided email, in case when FB does not return email
name	string	No	Customer Username

Body

Headers

Response

HTTP 200 Ok

{
   'auth_key': '[string]',
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

POST /auth/google

Headers

Parameters

Name	Type	Required	Description
token	string	Yes	Google Token which you get by FB.js, for testing you can visit page Google Login API Explorer and grab your user token, see image
subscribe	boolean	Yes	1- Subscribe, 0 - not, by default is 1 (True
time_zone	string	No	Customer Time Zone, if submit wrong time zone then will be used App default time zone
country	string	No	Customer Detected Country
skip_cart_merge	boolean	No	Mark as TRUE if need to do cart merge after sign up, default FALSE
checkout_token	string	No	Checkout token, use for sign up on checkout page, if wrong checkout token then it will show error
identity	string	No	Customer identity
invited_by_token	string	No	Customer invited by token, if token is wrong then invitation will be ignored

Body

Headers

Response

HTTP 200 Ok

{
   'auth_key': '[string]',
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

Customer

GET /customer/access

Get access keys for using API

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{
      'headers': '[object]'
 }

GET /customer

Get info about logged user [auth]

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

PUT /customer

Update Info for logged customer [auth]

Headers

Parameters

Name	Type	Required	Description
firstname	string	No	Customer First Name
lastname	string	No	Customer Last Name
email	string	No	Customer Email
relationship	string	No	Relationship: 'Single', 'Married', 'Engaged', 'In a relationship'
birthday	string	No	Birthday format Y-m-d
gender	string	No	GenderL 'male', 'female', 'other'
country	string	No	Country must be sent as name, ex: 'United States' or 'United Kingdom' etc

Body

Headers

Response

HTTP 200 Ok

{
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

POST /customer/shipping-address

Create Shipping Address of logged customer [auth]

Headers

Parameters

Name	Type	Required	Description
first_name	string	Yes	Shipping Address First Name
last_name	string	Yes	Shipping Address Last Name
company	string	No	Shipping Address Company
address_one	string	Yes	Shipping Address Address One
address_two	string	No	Shipping Address Address Two
apartment_suite	string	No	Shipping Address Apartment Suite
city	string	Yes	Shipping Address City
zip	string	Yes	Shipping Address Zip
country	string	Yes	Shipping Address Country ex: 'United States' or 'United Kingdom' etc
region	string	No	Shipping Address Region
province	string	No	Shipping Address Province
phone	number	Yes	Shipping Address Phone
is_default	boolean	No	Shipping Address Is Default: 1 for TRUE and 0 for FALSE

Body

Headers

Response

HTTP 200 Ok

{
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
 }

PUT /customer/shipping-address/{id}

Update Shipping Address of logged customer [auth]

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Id of customer shipping address which have to be updated
first_name	string	Yes	Shipping Address First Name
last_name	string	Yes	Shipping Address Last Name
company	string	No	Shipping Address Company
address_one	string	Yes	Shipping Address Address One
address_two	string	No	Shipping Address Address Two
apartment_suite	string	No	Shipping Address Apartment Suite
city	string	Yes	Shipping Address City
zip	string	Yes	Shipping Address Zip
country	string	Yes	Shipping Address Country ex: 'United States' or 'United Kingdom' etc
region	string	No	Shipping Address Region
province	string	No	Shipping Address Province
phone	number	Yes	Shipping Address Phone
is_default	boolean	No	Shipping Address Is Default: 1 for TRUE and 0 for FALSE

Body

Headers

Response

HTTP 200 Ok

{
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
 }

POST /customer/forgot-password

Customer forgot password request, send Forgot Password email [not_auth]

Headers

Parameters

Name	Type	Required	Description
email	string	Yes	Email of customer who forgot password
checkout_token	string	No	Current checkout token, use for forgot password on checkout page

Body

Headers

Response

HTTP 204 Ok

POST /customer/reset-password

Customer reset password

Headers

Parameters

Name	Type	Required	Description
password_reset_token	string	No	Reset Password Hash is not required if sent current_password
current_password	string	No	Current password of user is not required if sent password_reset_token
password	string	Yes	New Password
confirm_password	string	Yes	Confirmed New Password

Body

Headers

Response

HTTP 200 Ok

{
   'auth_key': '[string]',
   'id': '[integer]',
   'username': '[string]',
   'email': '[string]',
   'firstname': '[string]',
   'lastname': '[string]',
   'birthday': '[string]',
   'gender': '[string]',
   'detected_country': '[string]',
   'relationship': '[string]',
   'subscribed': '[boolean]',
   'shipping_info': [
     {
       'id': '[integer]',
       'first_name': '[string]',
       'last_name': '[string]',
       'company': '[string]',
       'address_one': '[string]',
       'address_two': '[string]',
       'apartment_suite': '[string]',
       'city': '[string]',
       'zip': '[string]',
       'country': '[string]',
       'region': '[string]',
       'province': '[string]',
       'phone': '[string]',
       'is_default': '[boolean]'
     }
   ]
 }

GET /customer/verify-reset-password/{token}

Customer verify reset password token

Headers

Parameters

Name	Type	Required	Description
token	string	No	Reset Password Hash

Body

Headers

Response

HTTP 200 Ok

{}

GET /customer/subscribe/{uuid}

Customer subscribe info

Headers

Parameters

Name	Type	Required	Description
uuid	string	Yes	Subscription UUID

Body

Headers

Response

HTTP 200 Ok

{}

POST /customer/subscribe

Customer subscribe

Headers

Parameters

Name	Type	Required	Description
email	string	Yes	Subscription email
identity	string	No	Customer identity
utms[]	array	No	Utms Params, EX: utms[country]=USA, utms[ip]=127.0.0.1
behaviour	string	No	Subscription behaviour. EX: roulette or hdresponse or cart or specific_club
behaviour_params[]	array	No	Additional params for subscription behaviour, EX: behaviour_params[session]=some_info

Body

Headers

Response

HTTP 200 Ok

{}

PUT /customer/subscribe/{uuid}

Set subscriber info

Headers

Parameters

Name	Type	Required	Description
uuid	string	Yes	Subscription UUID
name	string	Yes	Subscriber name
day	integer	Yes	Day of birthday
month	integer	Yes	Month of birthday
year	integer	Yes	Year of birthday
gender	string	Yes	Gender: male, female, other

Body

Headers

Response

HTTP 200 Ok

{}

DELETE /customer/subscribe/{uuid}

Customer unsubscribe

Headers

Parameters

Name	Type	Required	Description
uuid	string	Yes	Subscription UUID
unsubscribe_note	string	Yes	Unsubscribe note

Body

Headers

Response

HTTP 200 Ok

{}

POST /customer/withdraw-request

Customer withdraw request

Headers

Parameters

Name	Type	Required	Description
amount	integer	Yes	Withdraw request amount

Body

Headers

Response

HTTP 200 Ok

{}

Checkout

POST /checkout/create

Create Checkout

Headers

Parameters

Name	Type	Required	Description
cart_uuid	string	No	Customer cart Uuid
identity	string	No	Customer Identity
coupon	string	No	Coupon (Discount

Body

Headers

Response

HTTP 200 Ok

{}

GET /checkout/{checkout_token}

Get Checkout Details

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token
funnel	boolean	Yes	Funnel 1, Not Funnel 0, by default is 0

Body

Headers

Response

HTTP 200 Ok

{}

POST /checkout/{checkout_token}/details

Set Checkout Details

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token
email	string	Yes	Customer Email
password	string	No	Customer Password for provided Email
subscribe	boolean	Yes	Do subscribe 1, Don't subscribe 0, by default is 1
time_zone	string	No	Customer Time Zone, if submit wrong time zone then will be used App default time zone
detected_country	string	No	Customer Detected Country
skip_cart_merge	boolean	No	Mark as TRUE if need to do cart merge after sign up, default FALSE
identity	string	No	Customer identity
invited_by_token	string	No	Customer invited by token, if token is wrong then invitation will be ignored
billing_same_as_shipping	boolean	No	Use same address as Shipping: 1, Billing have to be other: 0
shipping_address[first_name]	boolean	Yes	Shipping Address First Name
shipping_address[last_name]	boolean	Yes	Shipping Address Last Name
shipping_address[phone]	boolean	Yes	Shipping Address Phone
shipping_address[address_one]	boolean	Yes	Shipping Address Address One
shipping_address[city]	boolean	Yes	Shipping Address City
shipping_address[zip]	boolean	Yes	Shipping Address Zip
shipping_address[country]	boolean	Yes	Shipping Address Country
shipping_address[province]	boolean	No	Shipping Address Province
shipping_address[state]	boolean	No	Shipping Address State
shipping_address[region]	boolean	No	Shipping Address Region
shipping_address[apartment_suite]	boolean	No	Shipping Address Apartment Suite
billing_address[first_name]	boolean	Yes	Billing Address First Name
billing_address[last_name]	boolean	Yes	Billing Address Last Name
billing_address[phone]	boolean	Yes	Billing Address Phone
billing_address[address_one]	boolean	Yes	Billing Address Address One
billing_address[city]	boolean	Yes	Billing Address City
billing_address[zip]	boolean	Yes	Billing Address Zip
billing_address[country]	boolean	Yes	Billing Address Country
billing_address[province]	boolean	No	Billing Address Province
billing_address[state]	boolean	No	Billing Address State
billing_address[region]	boolean	No	Billing Address Region
billing_address[apartment_suite]	boolean	No	Billing Address Apartment Suite

Body

Headers

Response

HTTP 200 Ok

{}

POST /checkout/{checkout_token}/delivery

Set Checkout Delivery Method [auth]

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token
shipping_option_id	inteher	Yes	Shipping option id

Body

Headers

Response

HTTP 200 Ok

{}

POST /checkout/{checkout_token}/payment

Checkout Payment [auth]

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token
payment_token	string	Yes	Payment Token
amount	integer	Yes	Payment Amount
payment_type	string	Yes	Payment Type, name of payment service or 'free_payment' for free payments
identity	string	No	Customer identity
order_additional_fields	string	No	Have to be array if you want to set some additional data

Body

Headers

Response

HTTP 204 Ok

{}

POST /checkout/{checkout_token}/init-payment

Init Payment, used for example for PayPal [auth]

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token
service	string	Yes	Payment service, for example 'paypal'
additional	array	No	Payment Additional fields

Body

Headers

Response

HTTP 200 Ok

{}

POST /checkout/{checkout_token}/execute-payment

Execute Initiated Payment, used for example for PayPal [auth]

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token
service	string	Yes	Payment service, for example 'paypal'
additional	array	No	Payment Additional fields

Body

Headers

Response

HTTP 200 Ok

{}

POST /checkout/{checkout_token}/coupon

Apply Discount/Gift Card

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token
coupon	string	Yes	Coupon code

Body

Headers

Response

HTTP 200 Ok

{}

GET /checkout/{checkout_token}/after-payment

Get Checkout Details After Payment [auth]

Headers

Parameters

Name	Type	Required	Description
checkout_token	string	Yes	Checkout Token

Body

Headers

Response

HTTP 200 Ok

{}

Orders

GET /orders

Get Orders List for a day, can be used expand [auth]

Headers

Parameters

Name	Type	Required	Description
offset	integer	No	Limit of how many items must be returned, default is 16
page	integer	No	Pagination page number, default is 1
order_by	string	No	Order By id, paid_at, created_at, payment_status, total_price
order_type	string	No	Order Type asc, desc

Body

Headers

Response

HTTP 200 Ok

{}

expand to 'fulfilment'

{
    'fulfilment': {}
 }

expand to 'discount'

{
    'discount': {}
 }

expand to 'gift'

{
    'gift': {}
 }

expand to 'verify_payment_files'

{
    'verify_payment_files': {}
 }

GET /order/{id}

Get Order By Id [auth]

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Order Id

Body

Headers

Response

HTTP 200 Ok

{}

expand to 'fulfilment'

{
    'fulfilment': {}
 }

expand to 'discount'

{
    'discount': {}
 }

expand to 'gift'

{
    'gift': {}
 }

expand to 'verify_payment_files'

{
    'verify_payment_files': {}
 }

PUT /order/update-additional

Update Order Additional Information

Headers

Parameters

Name	Type	Required	Description
order_id	integer	Yes	Order Id
email	string	Yes	Email of Customer
hd_processed	integer	Yes	Hd Requests Processed
hd_waiting	integer	Yes	Hd Requests Waiting
hd_skip	integer	Yes	Hd Requests Skip
success_chats	boolean	Yes	Has Success Chats
session_count	integer	Yes	Session Count
video_url	string	Yes	video_url
gclid	string	Yes	gclid
campaign_source	string	Yes	campaign_source
utm_source	string	Yes	utm_source
utm_campaign	string	Yes	utm_campaign
utm_medium	string	Yes	utm_medium
utm_adgroup	string	Yes	utm_adgroup
utm_keyword	string	Yes	utm_keyword
utm_ad	string	Yes	utm_ad
utm_matchtype	string	Yes	utm_matchtype
utm_adid	string	Yes	utm_adid
utm_adposition	string	Yes	utm_adposition
utm_devicemodel	string	Yes	utm_devicemodel
utm_geoid	string	Yes	utm_geoid
utm_placement	string	Yes	utm_placement

Body

Headers

Response

HTTP 200 Ok

{}

POST /order/return

Request order return

Headers

Parameters

Name	Type	Required	Description
order	string	Yes	Order number like #1342 OR order ID like 1342
email	string	Yes	Customer email

Body

Headers

Response

HTTP 204 Ok

POST /order/remind

Request to remind orders list, will sent email with orders

Headers

Parameters

Name	Type	Required	Description
email	string	Yes	Customer email

Body

Headers

Response

HTTP 204 Ok

POST /order/{id}/verify-payment

Upload additional documents for verifying order [auth]

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Order id
verify_payment_file[]	multi_file	Yes	Documents for verifying order

Body

Headers

Response

HTTP 204 Ok

POST /order/{id}/cancellation

Request order cancellation [auth]

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Order id
note	string	Yes	Cancellation note
reason	string	Yes	Cancellation reason, see reason list in 'GET /options' by key 'order_cancellation_reasons'

Body

Headers

Response

HTTP 200 Ok

{}

DELETE /order/{id}/cancellation

Request order cancellation [auth]

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Order id

Body

Headers

Response

HTTP 204 Ok

GET /order/{id}/items-to-refund

Get possible items for order refund [auth]

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Order id

Body

Headers

Response

HTTP 200 Ok

{}

POST /order/{id}/refund

Request order refund [auth]

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Order id
products[]	array	Yes	Refund products
refund_reason	string	Yes	Cancellation reason, see reason list in 'GET /options' by key 'order_cancellation_reasons'

Body

Headers

Response

HTTP 200 Ok

{}

GET /order/{id}/tracking

Get possible items for order refund

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Order id
uuid	string	Yes	Customer Uuid, used for autologin

Body

Headers

Response

HTTP 200 Ok

{}

Products

GET /products

Get Products List

Headers

Parameters

Name	Type	Required	Description
offset	integer	No	Limit of how many items must be returned, default is 16
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
     {
         'id': '[integer]',
         'title': '[string]',
         'body_html': '[string]',
         'vendor': null,
         'product_type': '[string]',
         'created_at': '[string]',
         'updated_at': '[string]',
         'published_at': '[string]',
         'handle': 'first-product',
         'template_suffix': '[string]',
         'published_scope': '[string]',
         'tags': '[string]',
         'variants': [
             {
                 'id': '[integer]',
                 'product_id': '[integer]',
                 'title': '[string]',
                 'price': '[integer]',
                 'sku': '[string]',
                 'inventory_policy': '[string]',
                 'url': '[string]',
                 'compare_at_price': '[integer]',
                 'fulfillment_service': '[string]',
                 'inventory_management': '[string]',
                 'options': [
                     {
                         'id': '[integer]',
                         'variant_id': '[integer]',
                         'name': '[string]',
                         'value_id': '[integer]',
                         'value_name': '[string]'
                     }
                 ],
                 'created_at': '[string]',
                 'updated_at': '[string]',
                 'taxable': '[boolean]',
                 'barcode': '[string]',
                 'grams': '[integer]',
                 'image_id': '[integer]',
                 'inventory_item_id': '[integer]',
                 'inventory_quantity': '[integer]',
                 'old_inventory_quantity': '[integer]',
                 'weight': '[float]',
                 'weight_unit': '[string]',
                 'requires_shipping': '[booean]',
                 'seo_title': '[string]',
                 'seo_description': '[string]',
                 'image': {
                     'id': '[integer]',
                     'variant_id': '[integer]',
                     'created_at': '[string]',
                     'updated_at': '[string]',
                     'width': '[integer]',
                     'height': '[integer]',
                     'src': '[string]',
                     'tags': '[array]'
                 },
                 'related_products': '[array] list of related product variant ids',
                 'specifications': '[array] list of specification'
             }
         ],
         'options': [
             {
                 'id': '[integer]',
                 'product_id': '[integer]',
                 'name': '[string]',
                 'values': [
                     {
                         'id': '[integer]',
                         'name': '[string]'
                     }
                 ]
             }
         ],
         'images': [
             {
                 'id': '[integer]',
                 'product_id': '[integer]',
                 'created_at': '[string]',
                 'updated_at': '[string]',
                 'width': '[integer]',
                 'height': '[integer]',
                 'src': '[string]',
                 'tags': '[array]'
             }
         ],
         'all_images': [
             {
                 'id': '[integer]',
                 'product_id': '[integer]',
                 'variant_id': '[integer]',
                 'created_at': '[string]',
                 'updated_at': '[string]',
                 'width': '[integer]',
                 'height': '[integer]',
                 'src': '[string]',
                 'tags': '[array]'
             }
         ],
         'product_category': '[string]',
    'product_collection': '[string]'
     }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

GET /products/variants

Product Variants List with pagination and filters. Can be used expand ?expand=expand_property

Headers

Parameters

Name	Type	Required	Description
offset	integre	No	Limit of how many items have to be returned
page	integre	No	Request page number
types	array	No	Product Type IDs, see response of GET /products/types
order_by	string	No	Values: date, title, price, best_selling, search_match, review_rating
order_type	string	No	Values: desc, asc
filter_by	array	No	filter_by[option_key_name][]=option_value Example: filter_by[Buckle Plating][]=Rose Gold
search	string	No	Search by product title, etc. Use if need order by search_match for moving to the top best matched items

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
   {
      'id': '[integer]',
      'product_id': '[integer]',
      'title': '[string]',
      'price': '[integer]',
      'sku': '[string]',
      'inventory_policy': '[string]',
      'url': '[string]',
      'compare_at_price': '[integer]',
      'fulfillment_service': '[string]',
      'inventory_management': '[string]',
      'created_at': '[string]',
      'updated_at': '[string]',
      'taxable': '[boolean]',
      'barcode': '',
      'grams': '[integer]',
      'inventory_item_id': '[integer]',
      'allow_to_purchase': '[boolean]',
      'out_of_stock': '[boolean] If TRUE product can not be added to a cart',
      'inventory_quantity': '[integer]',
      'old_inventory_quantity': '[integer]',
      'weight': '[integer]',
      'weight_unit': '[string]',
      'requires_shipping': true,
      'seo_title': '[string]',
      'seo_description': '[string]',
      'images': [],
      'specifications': []
    }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

expand to 'all_images'

{
   'all_images': [
          {
              'id': '[integer]',
              'product_id': '[integer]',
              'uuid': '[string]',
              'variant_id':  '[integer]',
              'created_at': '[string]',
              'updated_at': '[string]',
              'width': '[integer]',
              'height': '[integer]',
              'src': '[string]',
              'tags': []
          }
      ]
 }

expand to 'product'

{
   'product': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'vendor': '[string]',
          'product_type': '[string]',
          'product_type_id': '[integer]',
          'created_at': '[string]',
          'updated_at': '[string]',
          'published_at': '[string]',
          'handle': '[string]',
          'template_suffix': '[string]',
          'published_scope': '[string]',
          'tags': [],
          'product_category': '[string]',
          'product_collection': '[string]'
      }
 }

expand to 'related_products'

{
   'related_products': '[array] list of related product variant ids'
 }

expand to 'options'

{
   'options': [
           {
               'id': '[integer]',
               'variant_id': '[integer]',
               'name': '[string]',
               'value_id': '[integer]',
               'value_name': '[string]'
           }
       ]
 }

POST /products/variants/subscriptions

Subscribe on out of stock products

Headers

Parameters

Name	Type	Required	Description
email	string	Yes	Subscription Email
product_ids[]	array	Yes	Ids of Product Variants

Body

Headers

Response

HTTP 200 Ok

{}

GET /products/types

Get list of product types and related options

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

[
   {
       'id': '[integer] Type Id',
       'name': '[string] Type Name',
       'options': {
           '[string] Option Name #1': [
               '[string] Option Value #1',
               '[string] Option Value #2',
               '[string] Option Value #N'
           ],
           '[string] Option Name #2': [
               '[string] Option Value #1',
               '[string] Option Value #2',
               '[string] Option Value #N'
           ],
           '[string] Option Name #N': [
               '[string] Option Value #1',
               '[string] Option Value #2',
               '[string] Option Value #N'
           ]
       }
   }]

GET /products/variants/list

Product Variants List by array ids. Can be used expand ?expand=expand_property

Headers

Parameters

Name	Type	Required	Description
product_ids	array	No	Product IDs array, Example: product_ids[]=1&product_ids[]=2

Body

Headers

Response

HTTP 200 Ok

{
      'id': '[integer]',
      'product_id': '[integer]',
      'title': '[string]',
      'price': '[integer]',
      'sku': '[string]',
      'inventory_policy': '[string]',
      'url': '[string]',
      'compare_at_price': '[integer]',
      'fulfillment_service': '[string]',
      'inventory_management': '[string]',
      'created_at': '[string]',
      'updated_at': '[string]',
      'taxable': '[boolean]',
      'barcode': '',
      'grams': '[integer]',
      'inventory_item_id': '[integer]',
      'allow_to_purchase': '[boolean]',
      'out_of_stock': '[boolean] If TRUE product can not be added to a cart',
      'inventory_quantity': '[integer]',
      'old_inventory_quantity': '[integer]',
      'weight': '[integer]',
      'weight_unit': '[string]',
      'requires_shipping': true,
      'seo_title': '[string]',
      'seo_description': '[string]',
      'images': [],
      'specifications': []
    }

expand to 'all_images'

{
   'all_images': [
          {
              'id': '[integer]',
              'product_id': '[integer]',
              'uuid': '[string]',
              'variant_id':  '[integer]',
              'created_at': '[string]',
              'updated_at': '[string]',
              'width': '[integer]',
              'height': '[integer]',
              'src': '[string]',
              'tags': []
          }
      ]
 }

expand to 'product'

{
   'product': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'vendor': '[string]',
          'product_type': '[string]',
          'product_type_id': '[integer]',
          'created_at': '[string]',
          'updated_at': '[string]',
          'published_at': '[string]',
          'handle': '[string]',
          'template_suffix': '[string]',
          'published_scope': '[string]',
          'tags': [],
          'product_category': '[string]',
          'product_collection': '[string]'
      }
 }

expand to 'related_products'

{
   'related_products': '[array] list of related product variant ids'
 }

expand to 'options'

{
   'options': [
           {
               'id': '[integer]',
               'variant_id': '[integer]',
               'name': '[string]',
               'value_id': '[integer]',
               'value_name': '[string]'
           }
       ]
 }

GET /products/top-sales

Get list of top sales products

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

[
       {
         'quantity': '[string]',
         'amount': '[string]',
         'product_variant': {
           'id': '[string]',
           'product_id': '[string]',
           'product_type_id': '[string]',
           'title': '[string]',
           'price': '[string]',
           'sku': '[string]',
           'inventory_policy': '[string]',
           'url': '[string]',
           'compare_at_price': '[string]',
           'fulfillment_service': '[string]',
           'inventory_management': '[string]',
           'created_at': '[string]',
           'updated_at': '[string]',
           'taxable': '[string]',
           'barcode': '[string]',
           'grams': '[string]',
           'inventory_item_id': '[string]',
           'allow_to_purchase': '[string]',
           'out_of_stock': '[boolean] If TRUE product can not be added to a cart',
           'inventory_quantity': '[string]',
           'old_inventory_quantity': '[string]',
           'weight': '[string]',
           'weight_unit': '[string]',
           'requires_shipping': '[string]',
           'seo_title': '[string]',
           'seo_description': '[string]',
           'images': '[array]',
           'specifications': '[array]'
         }
       }
     ]

GET /products/variants-by-colors

Product Variants List by detected colors. Can be used expand ?expand=expand_property

Headers

Parameters

Name	Type	Required	Description
colors	array	Yes	Detect product by colors list, expected colors without # and 6 chars, like ffffff

Body

Headers

Response

HTTP 200 Ok

{
      'id': '[integer]',
      'product_id': '[integer]',
      'title': '[string]',
      'price': '[integer]',
      'sku': '[string]',
      'inventory_policy': '[string]',
      'url': '[string]',
      'compare_at_price': '[integer]',
      'fulfillment_service': '[string]',
      'inventory_management': '[string]',
      'created_at': '[string]',
      'updated_at': '[string]',
      'taxable': '[boolean]',
      'barcode': '',
      'grams': '[integer]',
      'inventory_item_id': '[integer]',
      'allow_to_purchase': '[boolean]',
      'out_of_stock': '[boolean] If TRUE product can not be added to a cart',
      'inventory_quantity': '[integer]',
      'old_inventory_quantity': '[integer]',
      'weight': '[integer]',
      'weight_unit': '[string]',
      'requires_shipping': true,
      'seo_title': '[string]',
      'seo_description': '[string]',
      'images': [],
      'specifications': []
    }

expand to 'all_images'

{
   'all_images': [
          {
              'id': '[integer]',
              'product_id': '[integer]',
              'uuid': '[string]',
              'variant_id':  '[integer]',
              'created_at': '[string]',
              'updated_at': '[string]',
              'width': '[integer]',
              'height': '[integer]',
              'src': '[string]',
              'tags': []
          }
      ]
 }

expand to 'product'

{
   'product': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'vendor': '[string]',
          'product_type': '[string]',
          'product_type_id': '[integer]',
          'created_at': '[string]',
          'updated_at': '[string]',
          'published_at': '[string]',
          'handle': '[string]',
          'template_suffix': '[string]',
          'published_scope': '[string]',
          'tags': [],
          'product_category': '[string]',
          'product_collection': '[string]'
      }
 }

expand to 'related_products'

{
   'related_products': '[array] list of related product variant ids'
 }

expand to 'options'

{
   'options': [
           {
               'id': '[integer]',
               'variant_id': '[integer]',
               'name': '[string]',
               'value_id': '[integer]',
               'value_name': '[string]'
           }
       ]
 }

GET /products/search

Search Products

Headers

Parameters

Name	Type	Required	Description
q	string	Yes	Query string
limit	integer	No	Limit of how many items must be returned, default is 16
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
       {
           'id': '[integer]',
           'product_id': '[integer]',
           'product_type_id': '[integer]',
           'title': '[string]',
           'origin_title': '[string]',
           'price': '[integer]',
           'sku': '[string]',
           'inventory_policy': '[string]',
           'url': '[string]',
           'compare_at_price': '[integer]',
           'fulfillment_service': '[string]',
           'inventory_management': '[string]',
           'created_at': '[string]',
           'updated_at': '[string]',
           'taxable': true,
           'barcode': '[string]',
           'grams': '[integer]',
           'inventory_item_id': '[integer]',
           'allow_to_purchase': true,
           'out_of_stock': false,
           'inventory_quantity': '[integer]',
           'old_inventory_quantity': '[integer]',
           'weight': '[integer]',
           'weight_unit': '[string]',
           'requires_shipping': true,
           'seo_title': null,
           'seo_description': null,
           'images': [],
           'specifications': {
               'sku': {
                   'name': '[string]',
                   'value': '[string]',
                   'content': '[string]'
               }
           }
       }
   ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

expand to 'all_images'

{
   'all_images': [
          {
              'id': '[integer]',
              'product_id': '[integer]',
              'uuid': '[string]',
              'variant_id':  '[integer]',
              'created_at': '[string]',
              'updated_at': '[string]',
              'width': '[integer]',
              'height': '[integer]',
              'src': '[string]',
              'tags': []
          }
      ]
 }

expand to 'product'

{
   'product': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'vendor': '[string]',
          'product_type': '[string]',
          'product_type_id': '[integer]',
          'created_at': '[string]',
          'updated_at': '[string]',
          'published_at': '[string]',
          'handle': '[string]',
          'template_suffix': '[string]',
          'published_scope': '[string]',
          'tags': [],
          'product_category': '[string]',
          'product_collection': '[string]'
      }
 }

expand to 'related_products'

{
   'related_products': '[array] list of related product variant ids'
 }

expand to 'options'

{
   'options': [
           {
               'id': '[integer]',
               'variant_id': '[integer]',
               'name': '[string]',
               'value_id': '[integer]',
               'value_name': '[string]'
           }
       ]
 }

GET /products/variant/{id}

Get product variant by id. Can be used expand ?expand=expand_property

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Id of Product Variant

Body

Headers

Response

HTTP 200 Ok

{
      'id': '[integer]',
      'product_id': '[integer]',
      'title': '[string]',
      'price': '[integer]',
      'sku': '[string]',
      'inventory_policy': '[string]',
      'url': '[string]',
      'compare_at_price': '[integer]',
      'fulfillment_service': '[string]',
      'inventory_management': '[string]',
      'created_at': '[string]',
      'updated_at': '[string]',
      'taxable': '[boolean]',
      'barcode': '',
      'grams': '[integer]',
      'inventory_item_id': '[integer]',
      'allow_to_purchase': '[boolean]',
      'out_of_stock': '[boolean] If TRUE product can not be added to a cart',
      'inventory_quantity': '[integer]',
      'old_inventory_quantity': '[integer]',
      'weight': '[integer]',
      'weight_unit': '[string]',
      'requires_shipping': true,
      'seo_title': '[string]',
      'seo_description': '[string]',
      'images': [],
      'specifications': [],
      'reviews_info': {
           'rating': '[number]',
           'count': '[integer]'
      },
      'questions_info': {
           'count': '[integer]'
      }
 }

expand to 'all_images'

{
   'all_images': [
          {
              'id': '[integer]',
              'product_id': '[integer]',
              'uuid': '[string]',
              'variant_id':  '[integer]',
              'created_at': '[string]',
              'updated_at': '[string]',
              'width': '[integer]',
              'height': '[integer]',
              'src': '[string]',
              'tags': []
          }
      ]
 }

expand to 'product'

{
   'product': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'vendor': '[string]',
          'product_type': '[string]',
          'product_type_id': '[integer]',
          'created_at': '[string]',
          'updated_at': '[string]',
          'published_at': '[string]',
          'handle': '[string]',
          'template_suffix': '[string]',
          'published_scope': '[string]',
          'tags': [],
          'product_category': '[string]',
          'product_collection': '[string]'
      }
 }

expand to 'related_products'

{
   'related_products': '[array] list of related product variant ids'
 }

expand to 'options'

{
   'options': [
           {
               'id': '[integer]',
               'variant_id': '[integer]',
               'name': '[string]',
               'value_id': '[integer]',
               'value_name': '[string]'
           }
       ]
 }

expand to 'reviews'

{
   'reviews': {
           'count': '[integer]',
           'list': [
              {
                'id': '[integer]',
                'product_id': '[integer]',
                'review_title': '[string]',
                'review_description': '[string]',
                'product_variant_id': '[integer]',
                'customer_id': '[integer]',
                'reviewed_by': '[array]',
                'created_at': '[integer]',
                'updated_at': '[integer]',
                'user_name': '[string]',
                'user_email': '[string]',
                'status': '[string]'
              }
           ]
       }
 }

expand to 'questions'

{
   'questions': {
           'count': '[integer]',
           'list': [
               {
                  'id': '[integer]',
                  'product_id': '[integer]',
                  'customer_id': '[integer]',
                  'related_to': '[integer]',
                  'user_name': '[string]',
                  'user_email': '[string]',
                  'content': '[string]',
                  'type': '[string]',
                  'status': '[string]',
                  'reviewed_by': '[array]',
                  'created_at': '[integer]',
                  'updated_at': '[integer]',
                  'product_variant_id': '[integer]',
                  'answered_at': '[integer]'
                }
           ]
       }
 }

POST /products/variant/{id}/review

Add Review For Product

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Id of Product Variant
name	string	No	User Name if User not Logged
email	string	No	User Email if User not Logged
title	string	No	Review Title
description	string	No	Review Description
rating	number	No	Review Rating like 1 or 1.5 etc
files[]	multi_file	No	Review Files, up to 3 files png, jpg, jpeg

Body

Headers

Response

HTTP 200 Ok

{
   'id': '[integer]',
   'product_id': '[integer]',
   'review_title': '[string]',
   'review_description': '[string]',
   'product_variant_id': '[integer]',
   'customer_id': '[integer]',
   'reviewed_by': '[array]',
   'created_at': '[integer]',
   'updated_at': '[integer]',
   'user_name': '[string]',
   'user_email': '[string]',
   'status': '[string]',
  'images': '[array]'
 }

POST /products/variant/{id}/question

Add Question To The Product

Headers

Parameters

Name	Type	Required	Description
id	integer	Yes	Id of Product Variant
name	string	No	User Name if User not Logged
email	string	No	User Email if User not Logged
content	string	No	Question content

Body

Headers

Response

HTTP 200 Ok

{
   'id': '[integer]',
   'product_id': '[integer]',
   'review_title': '[string]',
   'review_description': '[string]',
   'product_variant_id': '[integer]',
   'customer_id': '[integer]',
   'reviewed_by': '[array]',
   'created_at': '[integer]',
   'updated_at': '[integer]',
   'user_name': '[string]',
   'user_email': '[string]',
   'status': '[string]',
  'images': '[array]'
 }

Cart

POST /cart/product/{product_id}

Add Item to a cart

Headers

Parameters

Name	Type	Required	Description
product_id	integer	Yes	Id of product
quantity	integer	Yes	Items quantity, how many have to be added to a cart
cart_uuid	string	Yes	cart Uuid

Body

Headers

Response

HTTP 200 Ok

{
  'id': '[integer]',
  'properties': 'null',
  'quantity': '[integer]',
  'variant_id': '[integer]',
  'key': 'null',
  'title': '[string]',
  'price': '[integer]',
  'original_price': '[integer]',
  'discounted_price': '[integer]',
  'line_price': '[integer]',
  'original_line_price': '[integer]',
  'total_discount': '0',
  'discounts': '[empty array]',
  'sku': '[string]',
  'grams': '[integer]',
  'taxable': '[boolean]',
  'product_id': '[integer]',
  'gift_card': '[boolean]',
  'url': '[string]',
  'image': '[string]',
  'handle': '[string]',
  'requires_shipping': '[boolean]',
  'product_type': '[string]',
  'product_title': '[string]',
  'product_description': '[string]',
  'variant_title': '[string]',
  'variant_options': '[object]',
  'product_options': '[object]',
  'related_products': '[object]'
 }

GET /cart

Get cart information

Headers

Parameters

Name	Type	Required	Description
cart_uuid	string	No	Cart Uuid

Body

Headers

Response

HTTP 200 Ok

{
  'token': '[string]',
  'note': 'null',
  'attributes': '[array]',
  'original_total_price': '[integer]',
  'total_price': '[integer]',
  'total_discount': '[integer]',
  'total_weight': '[integer]',
  'item_count': '[integer]',
  'items': '[object]'
 }

PUT /cart/product/{product_id}

Update item in a cart

Headers

Parameters

Name	Type	Required	Description
product_id	integer	Yes	Id of product
quantity	integer	Yes	Items quantity, how many have to be added to a cart
cart_uuid	string	Yes	cart Uuid

Body

Headers

Response

HTTP 200 Ok

{
  'id': '[integer]',
  'properties': 'null',
  'quantity': '[integer]',
  'variant_id': '[integer]',
  'key': 'null',
  'title': '[string]',
  'price': '[integer]',
  'original_price': '[integer]',
  'discounted_price': '[integer]',
  'line_price': '[integer]',
  'original_line_price': '[integer]',
  'total_discount': '0',
  'discounts': '[empty array]',
  'sku': '[string]',
  'grams': '[integer]',
  'taxable': '[boolean]',
  'product_id': '[integer]',
  'gift_card': '[boolean]',
  'url': '[string]',
  'image': '[string]',
  'handle': '[string]',
  'requires_shipping': '[boolean]',
  'product_type': '[string]',
  'product_title': '[string]',
  'product_description': '[string]',
  'variant_title': '[string]',
  'variant_options': '[object]',
  'product_options': '[object]',
  'related_products': '[object]'
 }

DELETE /cart/product/{product_id}

Delete item from a cart

Headers

Parameters

Name	Type	Required	Description
cart_uuid	string	Yes	cart Uuid
product_id	integer	Yes	product

Body

Headers

Response

HTTP 204 Ok

POST /cart/merge

Get cart information

Headers

Parameters

Name	Type	Required	Description
cart_uuid	string	No	Cart Uuid
merge	string	No	Do merge: 1, Don't do merge: 0

Body

Headers

Response

HTTP 200 Ok

{
  'token': '[string]',
  'note': 'null',
  'attributes': '[array]',
  'original_total_price': '[integer]',
  'total_price': '[integer]',
  'total_discount': '[integer]',
  'total_weight': '[integer]',
  'item_count': '[integer]',
  'items': '[object]'
 }

POST /cart/discount

Apply discount to cart

Headers

Parameters

Name	Type	Required	Description
cart_uuid	string	No	Cart Uuid
code	string	No	Discount code

Body

Headers

Response

HTTP 200 Ok

{}

Settings

GET /settings/price-format-symbol/{price}

Format price

Headers

Parameters

Name	Type	Required	Description
price	integer	Yes	Integer of price in cents

Body

Headers

Response

HTTP 200 Ok

{
  'id': '[integer]',
  'code': '[string]',
  'type': '[string]',
  'value': '[integer]',
  'minimum_purchase': '[boolean]',
  'minimum_purchase_value': '[integer]',
  'limit_items': '[integer]',
  'limit_one_user': '[boolean]',
  'applies_to': '[integer]',
  'gift': '[string]',
  'status': '[boolean]',
  'created_at': '[string] YYYY-MM-DDTHH:mm:ss+00:00',
  'updated_at': '[string] YYYY-MM-DDTHH:mm:ss+00:00',
  'active_time': '[string] YYYY-MM-DDTHH:mm:ss+00:00',
  'end_time': '[string] YYYY-MM-DDTHH:mm:ss+00:00'
 }

GET /settings/customer-password

Info about Customer Password, for ex, if system will generate password automatically for Sign Up

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{
  'generate_password_for_user_automatically': '[boolean]'
 }

GET /settings

Get All store settings

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{}

Collections

GET /collections

Get Collections List [expand]Can be used expand ?expand=expand_property[/expand]

Headers

Parameters

Name	Type	Required	Description
offset	integer	No	Limit of how many items must be returned, default is 16
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
      {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'visible': true,
          'handle': '[string]',
          'seo_title': '[string]',
          'seo_description': '[string]',
          'seo_keywords': '[string]',
          'media': '[object]',
          'product_conditions': '[array]',
          'condition': '[string]'
      }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

expand to 'category'

{
    'category': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'visible': true,
          'handle': '[string]',
          'seo_title': '[string]',
          'seo_description': '[string]',
          'seo_keywords': '[string]',
          'media': '[object]',
          'product_conditions': '[array]',
          'condition': '[string]'
  }
 }

GET /collection/{handle}

Get Specific Collection [expand]Can be used expand ?expand=expand_property[/expand]

Headers

Parameters

Name	Type	Required	Description
handle	string	Yes	Collection handle

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
      {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'visible': true,
          'handle': '[string]',
          'seo_title': '[string]',
          'seo_description': '[string]',
          'seo_keywords': '[string]',
          'media': '[object]',
          'product_conditions': '[array]',
          'condition': '[string]'
      }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

expand to 'category'

{
    'category': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'visible': true,
          'handle': '[string]',
          'seo_title': '[string]',
          'seo_description': '[string]',
          'seo_keywords': '[string]',
          'media': '[object]',
          'product_conditions': '[array]',
          'condition': '[string]'
  }
 }

GET /collection/{handle}/products

Get Specific Collection Products [expand]Can be used expand ?expand=expand_property[/expand]

Headers

Parameters

Name	Type	Required	Description
handle	string	Yes	Collection handle
offset	integer	No	Limit of how many items must be returned, default is 16
page	integer	No	Pagination page number, default is 1
order_by	integer	No	Order Products by: date, title, price, best_selling, published_at
order_type	integer	No	Order type: asc, desc
{filter_options[]}	array	No	See possible filters list by GET /category/{handle}. Using Example: hair-type[]=heat-friendly-synthetic-hair&hair-type[]=hf-synthetic-hair etc.

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
       {
         'id': '[integer]',
         'product_id': '[integer]',
         'product_type_id': '[integer]',
         'title': '[string]',
         'origin_title': '[string]',
         'price': '[integer]',
         'sku': '[string]',
         'inventory_policy': '[string]',
         'url': '[string]',
         'compare_at_price': '[integer]',
         'fulfillment_service': '[string]',
         'inventory_management': '[string]',
         'created_at': '[string]',
         'updated_at': '[string]',
         'taxable': '[boolean]',
         'barcode': '[string]',
         'grams': '[integer]',
         'inventory_item_id': '[integer]',
         'allow_to_purchase': true,
         'out_of_stock': '[boolean]',
         'inventory_quantity': '[integer]',
         'old_inventory_quantity': '[integer]',
         'weight': '[integer]',
         'weight_unit': '[string]',
         'requires_shipping': '[boolean]',
         'seo_title': '[string]',
         'seo_description': '[string]',
         'body_html': '[string]',
         'images': '[array]',
         'specifications': '[object]',
         'additional_info': '[object]',
         'order_qty': '[integer]',
         'related_inventory_quantity': '[integer]',
         'tags': '[array]',
         'media_extension': '[string]',
         'media_uuid': '[string]',
         'media_src': '[string]',
         'public_title': '[string]'
       }
     ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

expand to 'all_images'

{
   'all_images': [
          {
              'id': '[integer]',
              'product_id': '[integer]',
              'uuid': '[string]',
              'variant_id':  '[integer]',
              'created_at': '[string]',
              'updated_at': '[string]',
              'width': '[integer]',
              'height': '[integer]',
              'src': '[string]',
              'tags': []
          }
      ]
 }

expand to 'product'

{
   'product': {
          'id': '[integer]',
          'title': '[string]',
          'body_html': '[string]',
          'vendor': '[string]',
          'product_type': '[string]',
          'product_type_id': '[integer]',
          'created_at': '[string]',
          'updated_at': '[string]',
          'published_at': '[string]',
          'handle': '[string]',
          'template_suffix': '[string]',
          'published_scope': '[string]',
          'tags': [],
          'product_category': '[string]',
          'product_collection': '[string]'
      }
 }

expand to 'related_products'

{
   'related_products': '[array] list of related product variant ids'
 }

expand to 'options'

{
   'options': [
           {
               'id': '[integer]',
               'variant_id': '[integer]',
               'name': '[string]',
               'value_id': '[integer]',
               'value_name': '[string]'
           }
       ]
 }

expand to 'reviews'

{
   'reviews': {
           'count': '[integer]',
           'list': [
              {
                'id': '[integer]',
                'product_id': '[integer]',
                'review_title': '[string]',
                'review_description': '[string]',
                'product_variant_id': '[integer]',
                'customer_id': '[integer]',
                'reviewed_by': '[integer]',
                'created_at': '[integer]',
                'updated_at': '[integer]',
                'user_name': '[string]',
                'user_email': '[string]',
                'status': '[string]'
              }
           ]
       }
 }

expand to 'questions'

{
   'questions': {
           'count': '[integer]',
           'list': [
               {
                  'id': '[integer]',
                  'product_id': '[integer]',
                  'customer_id': '[integer]',
                  'related_to': '[integer]',
                  'user_name': '[string]',
                  'user_email': '[string]',
                  'content': '[string]',
                  'type': '[string]',
                  'status': '[string]',
                  'reviewed_by': '[integer]',
                  'created_at': '[integer]',
                  'updated_at': '[integer]',
                  'product_variant_id': '[integer]',
                  'answered_at': '[integer]'
                }
           ]
       }
 }

Blog

GET /blog/categories

Get Categories List

Headers

Parameters

Name	Type	Required	Description
offset	integer	No	Limit of how many items must be returned, default is 16
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
      {
          'id': '[integer]',
          'title': '[string]',
          'slug': '[string]',
          'comments': '[integer]',
          'meta_description': '[string]',
          'redirect_url': '[string]',
          'created_at': '[integer]',
          'updated_at': '[integer]',
          'published_at': '[integer]',
          'created_at_atom': '[string]',
          'updated_at_atom': '[string]',
          'published_at_atom': '[string]',
          'visible':'[boolean]',
          'parent_category': '[integer]',
          'template_suffix': '[string]',
          'media_id': '[object]',
          'additional_info': '[object]',
          'meta_keywords': '[string]',
          'meta_title': '[string]'
      }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

GET /blog/categories/latest-posts

Get latest posts for each category

Headers

Parameters

Name	Type	Required	Description
offset	iteger	No	Limit how many items have to be returned. By default is 3

Body

Headers

Response

HTTP 200 Ok

{}

GET /blog/category/{category_id}/latest-posts

Get latest posts for specific category

Headers

Parameters

Name	Type	Required	Description
category_id	iteger	Yes	Blog Catgeory Id
offset	integer	No	Limit of how many items must be returned, default is 6
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{}

GET /blog/posts/latest

Get latest posts for specific category

Headers

Parameters

Name	Type	Required	Description
offset	integer	No	Limit of how many items must be returned, default is 6
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{}

GET /blog/posts

Get posts, can be used additional search conditions

Headers

Parameters

Name	Type	Required	Description
ids[]	array	No	Blog Post Ids
tags[]	array	No	Search blog posts by tags
except_ids[]	array	No	List ids which have to be ignored
offset	integer	No	Limit of how many items must be returned, default is 6
page	integer	No	Pagination page number, default is 1
order_type	string	No	Order type: 'asc', 'desc'
order_by	string	No	Order by: 'published_at', 'created_at', 'updated_at', 'title', 'excerpt', 'ids_positions'

Body

Headers

Response

HTTP 200 Ok

{}

GET /blog/category/{category_id}/post/{post_id}/top-stories

Get related top stories for the post

Headers

Parameters

Name	Type	Required	Description
category_id	integer	Yes	Blog Post Category for which is looking for same top stories
post_id	integer	Yes	Blog Post for which is looking for same top stories
offset	integer	No	Limit of how many items must be returned, default is 6
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{}

GET /blog/post/{post_id}/related-products

Get related products to the post

Headers

Parameters

Name	Type	Required	Description
post_id	integer	Yes	Blog Post for which is looking for same top stories
offset	integer	No	Limit of how many items must be returned, default is 6
page	integer	No	Pagination page number, default is 1

Body

Headers

Response

HTTP 200 Ok

{}

Statistic

PUT /statistic/segmentation

Update Segmentation Statistic

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

{}

GET /statistic/sales-report

Sales Report

Headers

Parameters

Name	Type	Required	Description
date_from	integer	Yes	TimeStamp Date Start
date_to	integer	Yes	TimeStamp Date End

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
      {
          'date': '[string]',
          'checked_data': '[integer]',
          'sent': '[integer]',
          'delivered': '[integer]',
          'add_to_cart': '[integer]',
          'begin_checkout': '[integer]',
          'swipe': '[integer]',
          'purchase': '[integer]',
          'open_count': '[integer]',
          'click_count': '[integer]',
          'bounced': '[integer]',
          'purchase_open': '[integer]',
          'purchase_click': '[integer]'
      }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

GET /statistic/refund

Refund Report

Headers

Parameters

Name	Type	Required	Description
date_from	integer	Yes	timestamp date start from
date_to	integer	Yes	timestamp date ent to
limit	integer	Yes	count of records

Body

Headers

Response

HTTP 200 Ok

[
  {
      'name': '[string]',
      'full_name': '[string]',
      'email': '[string]',
      'order_status': '[string]',
      'general_status': '[string]',
      'order_type': '[string]',
      'payment_risk_level': '[string]',
      'payment_service': '[string]',
      'transaction_amount': '[integer]',
      'country': '[string]',
      'city': '[string]',
      'region':'[string]',
      'source': '[string]',
      'payment_date': '[string]',
      'payment_time': '[string]',
      'requested_by': '[string]',
      'status': '[string]',
      'returned_amount': '[integer]',
      'refund_reason': '[string]',
      'refund_customer_reason': '[string]',
      'refund_date': '[string]',
      'refund_time': '[string]'
    }
  ]

GET /statistic/segmentation-report

Segmentation BI report

Headers

Parameters

Name	Type	Required	Description
page	integer	No	Pagination page number, default is 1
type	integer	No	1 - Total Report, 2 - Day report
date_from	integer	Yes	TimeStamp Date Start
date_to	integer	Yes	TimeStamp Date End
campaigns[]	array	No	Campaigns IDs
segments[]	array	No	Segments IDs
templates[]	array	No	Templates IDs
utm_campaigns[]	array	No	UTM Campaigns IDs
utm_sources[]	array	No	UTM Sources IDs
utm_adgroups[]	array	No	UTM Adgroups IDs
utm_keywords[]	array	No	UTM Keywords IDs
utm_ads[]	array	No	UTM ADS IDs
utm_adids[]	array	No	UTM ADIDs IDs

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
      {
          'date': '[string]',
          'checked_data': '[integer]',
          'sent': '[integer]',
          'delivered': '[integer]',
          'add_to_cart': '[integer]',
          'begin_checkout': '[integer]',
          'swipe': '[integer]',
          'purchase': '[integer]',
          'open_count': '[integer]',
          'click_count': '[integer]',
          'bounced': '[integer]',
          'purchase_open': '[integer]',
          'purchase_click': '[integer]'
      }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

GET /statistic/purchase-report

Purchase report

Headers

Parameters

Name	Type	Required	Description
date_from	integer	Yes	TimeStamp Date Start
date_to	integer	Yes	TimeStamp Date End

Body

Headers

Response

HTTP 200 Ok

[
      {
          'name': '[string]',
          'date': '[string]',
          'time': '[string]',
          'full_name': '[string]',
          'email': '[string]',
          'phone': '[string]',
          'country': '[string]',
          'city': '[string]',
          'region': '[string]',
          'total': '[integer]',
          'has_discount': '[boolean]',
          'discount_id': '[integer]',
          'has_additional_discount': '[boolean]',
          'discount_code': '[string]',
          'total_discounts': '[integer]',
          'payment_status': '[string]',
          'order_status': '[string]',
          'payment_service': '[string]',
          'processed_date': '[string]',
          'processed_time': '[string]',
          'payment_date': '[string]',
          'payment_time': '[string]',
          'swiped_attempts': '[integer]',
          'swiped_reasons': '[string]',
          'admin_url': '[string]',
          'products_name': '[string]',
          'products_sku': '[string]',
          'has_cancelation': '[boolean]',
          'has_refund': '[boolean]',
          'checkout_token': '[string]',
          'thank_views': '[boolean]',
          'order_type': '[string]',
          'service': '[string]',
          'service_id': '[string]',
          'status': '[string]',
          'risk_date': '[string]',
          'risk_time': '[string]',
          'risk_status': '[string]'
      }
 ]

GET /statistic/inventory-report

Inventory report

Headers

Parameters

Body

Headers

Response

HTTP 200 Ok

[
      {
          'origin_title': '[string]',
          'sku': '[string]',
          'allow_to_purchase': '[string]',
          'title': '[string]',
          'incoming_quantity': '[integer]',
          'inventory_quantity': '[integer]',
          'shipbob': '[integer]',
          'shipbob awaiting': '[integer]',
          'shipbob restocked': '[integer]',
          'shipbob on hold': '[integer]',
          'shiphero': '[integer]',
          'shiphero awaiting': '[integer]',
          'shiphero restocked': '[integer]',
          'shiphero on hold': '[integer]'
      }
 ]

GET /statistic/inventory-sales-report

Inventory Sales Report

Headers

Parameters

Name	Type	Required	Description
date_from	integer	Yes	TimeStamp Date Start
date_to	integer	Yes	TimeStamp Date End
page	integer	Yes	Page
limit	integer	Yes	Page limit
download	integer	No	Download Action, 0 - not download, 1 - download

Body

Headers

Response

HTTP 200 Ok

{
 'items': [
      {
          'name': '[string]',
          'email': '[string]',
          'sku': '[string]',
          'qty': '[integer]',
          'order_status': '[string]',
          'order_type': '[string]',
          'payment_status': '[string]',
          'service': '[string]',
          'paid': '[string]',
          'delivered_time': '[string]',
          'fulfilment_status': '[string]',
          'cancelation': '[string]',
          'refund': '[string]'
      }
 ],
 '_links': {
     'self': {
         'href': '[string]'
     },
     'first': {
         'href': '[string]'
     },
     'prev': {
         'href': '[string]'
     },
     'next': {
         'href': '[string]'
     },
     'last': {
         'href': '[string]'
     }
 },
  '_meta': {
     'totalCount': '[integer]',
     'pageCount': '[integer]',
     'currentPage':'[integer]',
     'perPage': '[integer]'
  }
 }

CRM Integration

PUT crm/entity

Create entity

Headers

Parameters

Name	Type	Required	Description
entity_type	string	Yes	Entity Type,'Leads'
data[user_name]	string	Yes	User Full Name
data[user_email]	string	Yes	User Email
data[user_phone]	string	Yes	Phone Number
data[country_of_residence]	string	Yes	Country of residence
data[country_of_birth]	string	Yes	Country of birth
data[source_campaign]	string	Yes	CRM Campaign ID or Name
data[year_of_birth]	string	Yes	Year of birth
crm	string	Yes	CRM Name, 'vtiger'

Body

Headers

Response

HTTP 200 Ok

{
      'email': '[string]',
      'emailoptout': '[integer]',
      'firstname': '[string]',
      'industry': '[string]',
      'lastname': '[string]',
      'leadstatus': '[string]',
      'lead_no': '[integer]',
      'noofemployees': '[integer]',
      'phone': '[string]',
      'rating': '[string]',
      'createdtime': '[string]',
      'modifiedtime': '[string]',
      'modifiedby': '[string]',
      'assigned_user_id': '[string]',
      'id': '[string]',
      'leadsource': '[string]',
      'cf_807': '[string]',
      'country': '[string]',
      'cf_805': '[string]',
      'cf_801': '[integer]',
      'cf_767': '[string]',
      'cf_989': '[string]',
      'cf_761': '[string]',
      'cf_765': '[string]',
      'cf_827': '[string]',
      'cf_848': '[string]',
      'cf_1144': '[string]',
      'cf_1045': '[integer]',
      'cf_1034': '[integer]',
      'cf_1036': '[integer]',
      'cf_1059': '[integer]',
      'cf_1075': '[integer]',
      'cf_1101': '[integer]',
      'cf_936': '[integer]',
      'converted': '[integer]',
      'assignleadchk': '[integer]',
      'deilerstatus':'[integer]',
      'updated_status': '[integer]',
      'amount': '[integer]'
  }

PUT crm/contact

Contact entity

Headers

Parameters

Name	Type	Required	Description
action	string	Yes	Entity Type,'Leads'
	string	Yes	User Full Name
data[user_email]	string	Yes	User Email
crm	string	Yes	CRM Name, 'vtiger'

Body

Headers

Response

HTTP 200 Ok

{
      'email': '[string]',
      'emailoptout': '[integer]',
      'firstname': '[string]',
      'industry': '[string]',
      'lastname': '[string]',
      'leadstatus': '[string]',
      'lead_no': '[integer]',
      'noofemployees': '[integer]',
      'phone': '[string]',
      'rating': '[string]',
      'createdtime': '[string]',
      'modifiedtime': '[string]',
      'modifiedby': '[string]',
      'assigned_user_id': '[string]',
      'id': '[string]',
      'leadsource': '[string]',
      'cf_807': '[string]',
      'country': '[string]',
      'cf_805': '[string]',
      'cf_801': '[integer]',
      'cf_767': '[string]',
      'cf_989': '[string]',
      'cf_761': '[string]',
      'cf_765': '[string]',
      'cf_827': '[string]',
      'cf_848': '[string]',
      'cf_1144': '[string]',
      'cf_1045': '[integer]',
      'cf_1034': '[integer]',
      'cf_1036': '[integer]',
      'cf_1059': '[integer]',
      'cf_1075': '[integer]',
      'cf_1101': '[integer]',
      'cf_936': '[integer]',
      'converted': '[integer]',
      'assignleadchk': '[integer]',
      'deilerstatus':'[integer]',
      'updated_status': '[integer]',
      'amount': '[integer]'
  }

Name	Type	Required	Description
handle	string	Yes	Category handle
offset	integer	No	Limit of how many items must be returned, default is 16
page	integer	No	Pagination page number, default is 1
order_by	integer	No	Order Products by: date, title, price, best_selling, published_at
order_type	integer	No	Order type: asc, desc
{filter_options[]}	array	No	See possible filters list by GET /category/{handle}. Using Example: hair-type[]=heat-friendly-synthetic-hair&hair-type[]=hf-synthetic-hair etc.

Api URL

Store

PUT /contact-us

GET /search

GET /options

POST /influencer

POST /job-apply

GET /translates

GET /languages

PUT /report-scam

GET /{first}/{second}/{third}

Authentication

POST /auth/login

POST /auth/logout

POST /auth/signup

POST /auth/uuid

POST /auth/password-reset-token

POST /auth/facebook

POST /auth/google

Customer

GET /customer/access

GET /customer

PUT /customer

POST /customer/shipping-address

PUT /customer/shipping-address/{id}

POST /customer/forgot-password

POST /customer/reset-password

GET /customer/verify-reset-password/{token}

GET /customer/subscribe/{uuid}

POST /customer/subscribe

PUT /customer/subscribe/{uuid}

DELETE /customer/subscribe/{uuid}

POST /customer/withdraw-request

Checkout

POST /checkout/create

GET /checkout/{checkout_token}

POST /checkout/{checkout_token}/details

POST /checkout/{checkout_token}/delivery

POST /checkout/{checkout_token}/payment

POST /checkout/{checkout_token}/init-payment

POST /checkout/{checkout_token}/execute-payment

POST /checkout/{checkout_token}/coupon

GET /checkout/{checkout_token}/after-payment

Orders

GET /orders

GET /order/{id}

PUT /order/update-additional

POST /order/return

POST /order/remind

POST /order/{id}/verify-payment

POST /order/{id}/cancellation

DELETE /order/{id}/cancellation

GET /order/{id}/items-to-refund

POST /order/{id}/refund

GET /order/{id}/tracking

Products

GET /products

GET /products/variants

POST /products/variants/subscriptions

GET /products/types

GET /products/variants/list

GET /products/top-sales

GET /products/variants-by-colors

GET /products/search

GET /products/variant/{id}

POST /products/variant/{id}/review

POST /products/variant/{id}/question

Cart

POST /cart/product/{product_id}

GET /cart

PUT /cart/product/{product_id}

DELETE /cart/product/{product_id}

POST /cart/merge

POST /cart/discount

Settings

GET /settings/price-format-symbol/{price}

GET /settings/customer-password

GET /settings

Collections

GET /collections