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

{"active": true}

Boolean - Whether or not the shop is active. This only applies to third party shops. An inactive third party shop will no longer have its orders imported into the system. Required.
connected

{"connected": true} Deprecated

Boolean - Whether or not the third party shop is connected to its external API. The system will set this to false if there are connection issues. Set by the system.
created

{"created": "2016-02-29 15:12:33"}

String - The date and time the shop was created. Set by the system.
expires

{"expires": "2016-09-02 12:10:54"} Deprecated

String - The date and/or time the access token expires in UTC. If the token never expires or is not relevant to the type of shop then the value will be Null. If the token does expire the user must reauthorize the BoxC API. Set by the system.
id

{"id": "my-shop"}

String - The user defined shop ID. It can contain the following characters only: "A-Za-z0-9-_". Required. Min length: 3. Max length: 32. This property is immutable. Shop IDs are unique across all accounts.
name

{"name": "Appleseeds"}

String - A user defined shop name. Max length: 32. Required.
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

{"type": "BoxC"}

String - The type of shop. Always "BoxC".
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