API documentation

/api/gateway/

POST /api/gateway/

Get authoruize.net pay button

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
sum	float	true	9.99	Order Summ
shopName	string	true	shopName	Shop name
orderId	string	true	order Id	order Id
iframeUrl	string	true	https://sitename.domen/emptyiframe.html	iframe Url for authorize.net
callBackUrl	string	true	https://sitename.domen/callBackUrl	callBackUrl Url for site

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/order/

GET /api/order/

Get Orders list

Documentation
Sandbox

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/order/

Create Order

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
receiverName	string	true	Full name	Receiver name
receiverEmail	string	true	email@gmail.com	Receiver email
receiverPhone	string	false	+380983333333	Receiver phone
receiverAddress	string	true	8062 Rosemary Ave. Esperance	Receiver address
receiverCity	string	true	New York	Receiver city
receiverZip	string	true	12066	Receiver zip
receiverState	string	true	NY	Receiver state
receiverCountry	string	true	US	Receiver country
weightLb	integer	false	2	weight in pound
weightOz	integer	false	3	weight in ounce
length	integer	false	10	length in sm
width	integer	false	5	width in sm
height	integer	false	2	height in sm
comment	text	false	comment	Comment
insurancesStatus	boolean	false	0\|1	Insurance? 0=No; 1=Yes
insurances	float	false	9.99	Insurance Amount
externalId	string	false	9898hjfdkh8932-436-dfsg	External Id max lenth 256
apiShipMethod	string	false	999_999	Ship Method
packagingId	string	false	1	External packaging Id
consolidationOrder	boolean	true	0\|1	Consolidation order ? 0=No; 1=Yes
skladCreateLabel	boolean	true	0\|1	sklad Create Label for order ? 0=No; 1=Yes
userPackType	string	false	pack1	pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/order/example

Get Orders POST|PUT exmaple

Documentation
Sandbox

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/order/exampleConsolidation

Get Orders Consolidation POST|PUT exmaple

Documentation
Sandbox

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/order/{id}

GET /api/order/{id}

Get Order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/order/{id}

Edit Order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id

Parameters

Parameter	Type	Required?	Format	Description
receiverName	string	true	Full name	Receiver name
receiverEmail	string	true	email@gmail.com	Receiver email
receiverPhone	string	false	+380983333333	Receiver phone
receiverAddress	string	true	8062 Rosemary Ave. Esperance	Receiver address
receiverCity	string	true	New York	Receiver city
receiverZip	string	true	12066	Receiver zip
receiverState	string	true	NY	Receiver state
receiverCountry	string	true	US	Receiver country
weightLb	integer	false	2	weight in pound
weightOz	integer	false	3	weight in ounce
length	integer	false	10	length in sm
width	integer	false	5	width in sm
height	integer	false	2	height in sm
comment	text	false	comment	Comment
insurancesStatus	boolean	false	0\|1	Insurance? 0=No; 1=Yes
insurances	float	false	9.99	Insurance Amount
externalId	string	false	9898hjfdkh8932-436-dfsg	External Id max lenth 253
apiShipMethod	string	false	999_999	Ship Method
packagingId	string	false	1	External packaging Id
consolidationOrder	boolean	true	0\|1	Consolidation order ? 0=No; 1=Yes
skladCreateLabel	boolean	true	0\|1	sklad Create Label for order ? 0=No; 1=Yes
userPackType	string	false	pack1	pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton
transactionId	string	false	124135	transaction Id for create order fron transaction

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/order/{id}/get-delivery-methods

Get available delivery methods for an order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/order/{id}/set-shipstation-code

Set ShipStation service code for an order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Parameters

Parameter	Type	Required?	Format	Description
serviceId	string	true	apc_priority_ddu_delcon:package	serviceId from delivery methods. Use /order/{id}/get-delivery-methods before.

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/order/{id}/track

Track Order by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/packaging-type/

GET /api/packaging-type/

Get Packaging Type list

Documentation
Sandbox

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/product/

GET /api/product/

Get Products list

Documentation
Sandbox

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/product/

Create Product

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
name	string	true	Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories	name
title	string	true	Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories	title
upc	string	true	B073QK9LZX	upc
sku	string	true	B072KG8H4M, BT-F10M-HAER	sku

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/product/{id}

GET /api/product/{id}

Get Product

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/product/{id}

Edit Product

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Parameters

Parameter	Type	Required?	Format	Description
name	string	true	Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories	name
title	string	true	Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories	title
upc	string	true	B073QK9LZX	upc
sku	string	true	B072KG8H4M, BT-F10M-HAER	sku
productPacketType	boolean	true	0\|1	Already prepacked in shippable box? 0=No; 1=Yes

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/shipping-method/

GET /api/shipping-method/

Get Shipping Method list

Documentation
Sandbox

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/transactions/

GET /api/transactions/

Get Transactions list

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
page	integer	false		current page defoult 1
numItemsPerPage	integer	false		num Items Per Page by default 20 max per page 100

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/transactions/{id}

GET /api/transactions/{id}

Get Order

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/transactions/{id}/create-order

Get json data from transation by id

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+

Parameters

Parameter	Type	Required?	Format	Description
orderType	string	false		set orderType one from list consolidation, self:create, sklad:create set consolidation if empty

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

/api/user-pack-type/

GET /api/user-pack-type/

Get User Pack Type list

Documentation
Sandbox

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/key-crm/create-order

Get json data from transation or etsy order

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Description
orderType	string	false	set orderType one from list consolidation, self:create, sklad:create set consolidation if empty
transaction	string	false	transaction number
etsy	string	false	etsy order id

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/rate/list

Get Rate list

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
senderCountryCode	string	true	US	Sender country code. Allowed only codes: UA (Ukraine), BY (Belarus) and US (USA)
length	string	true	10	Length, sm
height	string	true	10	Height, sm
width	string	true	10	Width, sm
weight	string	true	1	Weight, kg
countryCode	string	true	UA	Country code
stateCode	string	false	MN	Required when Country code - US
zipCode	string	true	02224	Zip (postal) code
city	string	true	Kyiv	City
clientPayPal	boolean	true	0\|1	PayPal client

Headers

Name	Required?	Description
Authorization	true	Basic + base64 encoded 'user_id:api_token'

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set