Shops
The Shops resource allows a user to manage their fulfillment shop. A shop with orders or SKUs cannot be deleted. Clients should use a third party platform for integrating their ecommerce marketplaces with the BoxC API.
Actions
GET /shops |
Retrieves a paginated list of shops |
GET /shops/{id} |
Retrieves a shop |
GET /shops/{id}/connect |
Initializes the shop authorization process |
POST /shops |
Creates a shop |
PUT /shops/{id} |
Updates a shop |
DELETE /shops/{id} |
Deletes a shop |
Properties
active |
|
connected |
|
created |
|
expires |
|
id |
|
name |
|
settings |
{ "settings": { "default_service": "BoxC Plus", "delay_processing": 24, "packing_slip": false, "partial_fulfillment": true } } Array - Default settings for the shop. Required. default_service: Deprecated String - Orders imported will inherit this setting as their shipping service. If the default service isn't available then it will be downgraded. Required.delay_processing: Integer - The number of hours an order should remain unprocessed in the system before packing. Orders will be processed if their created value plus the shop's delay_processing value is greater than the current time. Max: 240. Required. packing_slip: Deprecated Boolean - Whether or not orders imported from an external shop (e.g. a Shopify store) should include a packing slip in the shipment. Additional fees may apply. Default: false. Required. partial_fulfillment: Deprecated Boolean - Whether or not orders imported from an external shop (e.g. a Shopify store) should be partially fulfilled by default. Default: false. Required. |
type |
|
GET
/shops
Retrieves a list of shops
limit |
The number of results to return. Max: 100. Default: 50. |
name |
Filter that searches for shops with a similar name. Default: none. |
page |
The page number of the results. Default is 1. |
page_token |
Used for selecting the page after the initial query. |
request
GET /shops?limit=50&name=PhoneBlox
response
HTTP/1.1 200 OK
{ "shops": [ { "active": true, "connected": true, "created": "2016-03-01 22:15:35", "expires": null, "id": "my-shop", "name": "PhoneBlox", "settings": { "default_service": "BoxC Priority", "delay_processing": 48, "packing_slip": true, "partial_fulfillment": false }, "type": "BoxC" }, { "active": false, "connected": false, "created": "2016-01-01 08:09:23", "expires": null, "id": "myOtherShop", "name": "PhoneBlox Shopify", "settings": { "default_service": "BoxC Priority", "delay_processing": 0, "partial_fulfillment": true }, "type": "BoxC" } ], "next_page": null }
GET
/shops/{id}
Retrieves a shop
request
GET /shops/my-shop
response
HTTP/1.1 200 OK
{ "shop": { "active": true, "connected": true, "created": "2016-03-01 22:15:35", "expires": null, "id": "my-shop", "name": "Appleseeds", "settings": { "default_service": "BoxC Priority", "delay_processing": 48, "packing_slip": true, "partial_fulfillment": false }, "type": "BoxC" } }
GET
/shops/{id}/connect
Initializes the shop authorization process
request
GET /shops/my-shop/connect
response
HTTP/1.1 200 OK
This action returns a web page.
POST
/shops
Creates a shop
request
POST /shops
{ "shop": { "active": true, "id": "my-shop", "name": "Appleseeds", "settings": { "default_service": "BoxC Priority", "delay_processing": 48, "packing_slip": true, "partial_fulfillment": false }, "type": "BoxC" } }
response
HTTP/1.1 201 Created
{ "shop": { "active": true, "connected": true, "created": "2016-03-01 22:15:35", "expires": null, "id": "my-shop", "name": "Appleseeds", "settings": { "default_service": "BoxC Priority", "delay_processing": 48, "packing_slip": true, "partial_fulfillment": false }, "type": "BoxC" } }
PUT
/shops/{id}
Updates a shop
request
PUT /shops/my-shop
{ "shop": { "active": false, "name": "Appleseeds - Inactive", "settings": { "default_service": "BoxC Priority", "delay_processing": 0, "packing_slip": false, "partial_fulfillment": false } } }
response
HTTP/1.1 200 OK
{ "shop": { "active": false, "connected": true, "created": "2016-03-01 22:15:35", "expires": null, "id": "my-shop", "name": "Appleseeds - Inactive", "settings": { "default_service": "BoxC Priority", "delay_processing": 0, "packing_slip": false, "partial_fulfillment": false }, "type": "BoxC" } }
DELETE
/shops/{id}
Deletes a shop
request
DELETE /shops/my-shop
response
HTTP/1.1 200 OK