Brand Lovers Marketplace API - v1
Overview
This API allows sellers to: 1) Load products definitions to the BrandLovers marketplace. 2) Receive and update orders status. 3) Receive and update shipping information. 4) Receive and update customer tickets. All requests consume and return application/json content. All request must be authenticated and use HTTPS.
Endpoint URL:
https://api.brandlovers.com/marketplace/v1 (Production) https://sandbox.brandlovers.com/marketplace/v1 (Development Sandbox)
Security requirements:
All requests to this endpoint must use HTTPS. In order to use this endpoint user needs to use a token to authenticate. Tokens can be generated in the Admin panel admin panel
/products
POST
Allows new products from the seller to be loaded into the marketplace
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
products
body
JSON with a list of new products to be uploaded to the platform
String
Responses
200
Success! Server received your request and will start background processing.
400
Bad Request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
GET
Returns a list of products loaded into BrandLovers Marketplace
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number of items to retun. Defaults to 100. Max alowed is 200. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
POST Allows new products from the seller to be loaded into the marketplace
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| products | body | JSON with a list of new products to be uploaded to the platform | String |
Responses
200 Success! Server received your request and will start background processing.
400 Bad Request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
GET Returns a list of products loaded into BrandLovers Marketplace
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number of items to retun. Defaults to 100. Max alowed is 200. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/product/{skuSellerId}
GET
Returns details of a single product using the seller's `skuSellerId`
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
skuSellerId
path
SKU ID do Lojista.
String
Responses
200
Success!
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
404
Object not found. In general this means a invalid skuSellerId.
PUT
Update product details
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
skuSellerId
path
Unique Product Id (SKU) in the seller system that will be updated.
String
body
body
New product information.
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
404
Object not found.
GET Returns details of a single product using the seller's `skuSellerId`
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| skuSellerId | path | SKU ID do Lojista. | String |
Responses
200 Success!
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
404 Object not found. In general this means a invalid skuSellerId.
PUT Update product details
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| skuSellerId | path | Unique Product Id (SKU) in the seller system that will be updated. | String |
| body | body | New product information. | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
404 Object not found.
/product
POST
Create a new product on the marketplace
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
product
body
New Produt that will be create
String
Responses
200
Success! Server received your request and will start background processing.
400
Bad Request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
POST Create a new product on the marketplace
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| product | body | New Produt that will be create | String |
Responses
200 Success! Server received your request and will start background processing.
400 Bad Request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
/products/status
GET
Returns seller products status in the marketplace
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number of items to return in this query. Defaults to 250. Maximum 1000. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success fetching results.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
PUT
Bulk enable/disable products in the marketplace
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
List of seller products with new status information
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
GET Returns seller products status in the marketplace
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number of items to return in this query. Defaults to 250. Maximum 1000. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success fetching results.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
PUT Bulk enable/disable products in the marketplace
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | List of seller products with new status information | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
/products/prices
PUT
Allows bulk update of product prices.
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
Data for bulk product price update
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
PUT Allows bulk update of product prices.
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | Data for bulk product price update | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
/products/stocks
PUT
Bulk product stock update
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
Array of product SKUs.
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
PUT Bulk product stock update
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | Array of product SKUs. | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
/product/{skuSellerId}/status
PUT
Enable/disable a single product in the Marketplace
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
skuSellerId
path
Unique Product Id (SKU) in the seller system
String
body
body
Seller SKU that will be enabled or disabled
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
PUT Enable/disable a single product in the Marketplace
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| skuSellerId | path | Unique Product Id (SKU) in the seller system | String |
| body | body | Seller SKU that will be enabled or disabled | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
/product/{skuSellerId}/stock
PUT
Update a single prouduc stock
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
skuSellerId
path
Unique Product Id (SKU) in the seller system that will be updated
String
body
body
New product inventory information
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
PUT Update a single prouduc stock
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| skuSellerId | path | Unique Product Id (SKU) in the seller system that will be updated | String |
| body | body | New product inventory information | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
/product/{skuSellerId}/prices
PUT
Allows seller to update prices of a single SKU
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
skuSellerId
path
Product SKU
String
body
body
JSON document with the SKU price
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
PUT Allows seller to update prices of a single SKU
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| skuSellerId | path | Product SKU | String |
| body | body | JSON document with the SKU price | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
/products/status/selling
GET
Returns products that are successfully listed for sale.
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns products that are successfully listed for sale.
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders
GET
Returns orders details
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns orders details
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/shipments/delivered
POST
Bulk update of order shipments
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
ordersshipments
body
JSON body with list of shipments to be updated.
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET
Returns list of shipments
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
status
query
Query by shippment status.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
POST Bulk update of order shipments
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| ordersshipments | body | JSON body with list of shipments to be updated. | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns list of shipments
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| status | query | Query by shippment status. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/shipments/shipped
POST
Bulk update of order shipments
Parameters
Name
Located in
Description
Type
ordersshipments
body
JSON payload with list of shippments of orders.
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET
Returns a list of shipments shipped
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
status
query
Product status.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
POST Bulk update of order shipments
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| ordersshipments | body | JSON payload with list of shippments of orders. | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns a list of shipments shipped
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| status | query | Product status. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/status/approved
GET
Return list of approved orders
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 100, max 200. Use this in conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Return list of approved orders
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 100, max 200. Use this in conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/status/canceled
GET
Returns lists of canceled orders
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Default 100, max 250. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns lists of canceled orders
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Default 100, max 250. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/status/delivered
GET
Returns a list of orders successfully delivered associated with this seller.
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns a list of orders successfully delivered associated with this seller.
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/status/new
GET
Returns a list of orders flagged as new.
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns a list of orders flagged as new.
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/status/partiallyDelivered
GET
Returns a list of partially deliverd orders
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns a list of partially deliverd orders
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 100. Max 250. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/status/partiallySent
GET
Returns a list of orders partially fullfiled
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 100. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns a list of orders partially fullfiled
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 100. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/orders/status/sent
GET
Returns a list with orders fully sent
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
GET Returns a list with orders fully sent
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
/order/{orderId}
GET
Returns all details of a order
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
orderId
path
Unique Id of this order.
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
404
Object not found. Was not able to find orderId
GET Returns all details of a order
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| orderId | path | Unique Id of this order. | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Server refused to process your request. Please check the API SLA and reduce number of requests per second.
404 Object not found. Was not able to find orderId
/order/{orderId}/shipment/cancel
POST
Confirm shipment canceletion (when requested by the customer) or failure to deliver
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
String
orderId
path
Unique Order Id
String
Responses
200
success.
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404
Object not found. Was not able to find orderId
POST Confirm shipment canceletion (when requested by the customer) or failure to deliver
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | String | |
| orderId | path | Unique Order Id | String |
Responses
200 success.
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404 Object not found. Was not able to find orderId
/order/{orderId}/shipment/delivered
POST
Confirms that a shipment was delivered
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
String
orderId
path
Unique Order Id
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404
Object not found. Was not able to find orderId
POST Confirms that a shipment was delivered
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | String | |
| orderId | path | Unique Order Id | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404 Object not found. Was not able to find orderId
/order/{orderId}/shipment/exchange
POST
Confirm item exchange
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
String
orderId
path
Unique Order Id
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404
Object not found. Was not able to find orderId
POST Confirm item exchange
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | String | |
| orderId | path | Unique Order Id | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404 Object not found. Was not able to find orderId
/order/{orderId}/shipment/return
POST
Confirm order item return and refund
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
String
orderId
path
Order unique Id
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404
Object not found. Was not able to find orderId
POST Confirm order item return and refund
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | String | |
| orderId | path | Order unique Id | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404 Object not found. Was not able to find orderId
/order/{orderId}/shipment/sent
POST
Update new order to include shipment information
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
body
body
String
orderId
path
Unique Order Id
String
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404
Object not found. Was not able to find orderId
POST Update new order to include shipment information
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| body | body | String | |
| orderId | path | Unique Order Id | String |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
404 Object not found. Was not able to find orderId
/tickets
GET
Get customers trouble tickets
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
status
query
Query by trouble ticket status
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
GET Get customers trouble tickets
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| status | query | Query by trouble ticket status | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
/ticket
POST
Creates a new trouble ticket
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
newTicket
body
JSON object with new trouble ticket
String
Responses
200
Success!
400
Bad request.
POST Creates a new trouble ticket
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| newTicket | body | JSON object with new trouble ticket | String |
Responses
200 Success!
400 Bad request.
/ticket/{ticketId}/messages
GET
Get trouble ticket messages
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
ticketId
path
Trouble ticket ID.
String
offset
query
Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results.
Integer
limit
query
Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results.
Integer
Responses
200
Success!
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Access denied. You can only access your trouble tickets
GET Get trouble ticket messages
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| ticketId | path | Trouble ticket ID. | String |
| offset | query | Number or items to skip when executing query. List starts at zero. If omitted will default to zero. Use this conjuction with `limit` to paginate across the results. | Integer |
| limit | query | Number or items to return when executing query. Defaults to 10. Use this conjuction with `offset` to paginate across the results. | Integer |
Responses
200 Success!
400 Bad request.
401 Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403 Access denied. You can only access your trouble tickets
/ticket/{ticketId}/message
POST
Add new message to trouble ticket
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
ticketId
path
Trouble ticket ID.
String
message
body
New message object to append to trouble ticket.
String
Responses
200
Success!
400
Bad request.
404
Object not found.
POST Add new message to trouble ticket
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| ticketId | path | Trouble ticket ID. | String |
| message | body | New message object to append to trouble ticket. | String |
Responses
200 Success!
400 Bad request.
404 Object not found.
/ticket/{ticketId}/status
PUT
Update trouble ticket status
Parameters
Name
Located in
Description
Type
authorization
header
Authorization token. The Authorization token can be found in your Admin console.
String
ticketId
path
Trouble ticket unique identification
String
body
body
New trouble ticket status
String
Responses
200
successfully received transaction
400
Bad request.
401
Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
403
Server refused to process your request. Please check the API SLA and reduce number of requests per second.
404
Object not found.
PUT Update trouble ticket status
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| authorization | header | Authorization token. The Authorization token can be found in your Admin console. | String |
| ticketId | path | Trouble ticket unique identification | String |
| body | body | New trouble ticket status | String |