Skip to main content
API docs by Redocly

Documents Configuration (1.0)

Download OpenAPI specification:Download

Get Documents Configuration

Responses

Response samples

Content type
application/json
{
  • "stores": {
    },
  • "tenant": {
    }
}

Set Documents Configuration

Request Body schema: application/json
default
required
Array of strings (DocumentTypes)
Items Enum: "invoice" "packing_slip" "shipping_label" "return_label" "return_form"
default_optional
Array of strings (OptionalDocumentTypes)
Items Value: "commercial_invoice"
in_store_pick_up
Array of strings (InStorePickupDocumentTypes)
Items Enum: "invoice" "in_store_pickup_label" "packing_slip" "return_form"

Responses

Request samples

Content type
application/json
{
  • "default": [
    ],
  • "default_optional": [
    ],
  • "in_store_pick_up": [
    ]
}

Response samples

Content type
application/json
{
  • "default": [
    ],
  • "default_optional": [
    ],
  • "in_store_pick_up": [
    ]
}

Delete Store Documents Configuration

path Parameters
store_id
required
string (Store Id)

Responses

Response samples

Content type
application/json
null

Get Store Documents Configuration

path Parameters
store_id
required
string (Store Id)

Responses

Response samples

Content type
application/json
{
  • "default": [
    ],
  • "default_optional": [
    ],
  • "in_store_pick_up": [
    ]
}

Set Store Documents Configuration

path Parameters
store_id
required
string (Store Id)
Request Body schema: application/json
default
required
Array of strings (DocumentTypes)
Items Enum: "invoice" "packing_slip" "shipping_label" "return_label" "return_form"
default_optional
Array of strings (OptionalDocumentTypes)
Items Value: "commercial_invoice"
in_store_pick_up
Array of strings (InStorePickupDocumentTypes)
Items Enum: "invoice" "in_store_pickup_label" "packing_slip" "return_form"

Responses

Request samples

Content type
application/json
{
  • "default": [
    ],
  • "default_optional": [
    ],
  • "in_store_pick_up": [
    ]
}

Response samples

Content type
application/json
{
  • "default": [
    ],
  • "default_optional": [
    ],
  • "in_store_pick_up": [
    ]
}

Get Priority Service Levels

Returns a list of service levels that are considered to have the most priority to fulfill. The list is sorted most priority first. You can check how priority orders work in this guide All these service levels must exist in your fulfillment configuration.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Put Priority Service Levels

Set a list of service levels to identify Priority Orders, used both for Order assignment to Waves and the Fulfill Priority Orders functionality. In order for this configuration to work properly, those service levels must exist in your fulfillment configuration.

Request Body schema: application/json
value
required
Array of strings (ConfigPriorityServiceLevels)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
null