Documents Configuration (1.0)

Download OpenAPI specification:Download

Get Documents Configuration

Responses

Response samples

200
404

Content type

application/json

{"stores": {"store1": {"default": ["invoice",
"packing_slip",
"shipping_label"
],
"default_optional": ["commercial_invoice"
],
"in_store_pick_up": ["invoice",
"in_store_pickup_label"
]
},
"store2": {"default": ["invoice",
"packing_slip",
"shipping_label"
],
"in_store_pick_up": ["invoice"
]
}
},
"tenant": {"default": ["invoice",
"packing_slip",
"shipping_label",
"return_label",
"return_form"
],
"default_optional": ["commercial_invoice"
],
"in_store_pick_up": ["invoice",
"in_store_pickup_label"
]
}
}

Set Documents Configuration

Request Body schema: application/json

default required	Array of strings (Default) Items Enum: "invoice" "packing_slip" "shipping_label" "return_label" "return_form"
	Array of Default Optional (strings) or Default Optional (null) (Default Optional)
	Array of In Store Pick Up (strings) or In Store Pick Up (null) (In Store Pick Up)

Responses

Request samples

Payload

Content type

application/json

{"default": ["invoice",
"packing_slip",
"shipping_label",
"return_label",
"return_form"
],
"default_optional": ["commercial_invoice"
],
"in_store_pick_up": ["invoice",
"in_store_pickup_label"
]
}

Response samples

200
422

Content type

application/json

{"default": ["invoice",
"packing_slip",
"shipping_label",
"return_label",
"return_form"
],
"default_optional": ["commercial_invoice"
],
"in_store_pick_up": ["invoice",
"in_store_pickup_label"
]
}

Delete Store Documents Configuration

path Parameters

store_id

required

string (Store Id)

Responses

Response samples

200
422

Content type

application/json

null

Get Store Documents Configuration

path Parameters

store_id

required

string (Store Id)

Responses

Response samples

200
404
422

Content type

application/json

{"default": ["invoice",
"packing_slip",
"shipping_label",
"return_label",
"return_form"
],
"default_optional": ["commercial_invoice"
],
"in_store_pick_up": ["invoice",
"in_store_pickup_label"
]
}

Set Store Documents Configuration

path Parameters

store_id

required

string (Store Id)

Request Body schema: application/json

default required	Array of strings (Default) Items Enum: "invoice" "packing_slip" "shipping_label" "return_label" "return_form"
	Array of Default Optional (strings) or Default Optional (null) (Default Optional)
	Array of In Store Pick Up (strings) or In Store Pick Up (null) (In Store Pick Up)

Responses

Request samples

Payload

Content type

application/json

{"default": ["invoice",
"packing_slip",
"shipping_label",
"return_label",
"return_form"
],
"default_optional": ["commercial_invoice"
],
"in_store_pick_up": ["invoice",
"in_store_pickup_label"
]
}

Response samples

200
422

Content type

application/json

{"default": ["invoice",
"packing_slip",
"shipping_label",
"return_label",
"return_form"
],
"default_optional": ["commercial_invoice"
],
"in_store_pick_up": ["invoice",
"in_store_pickup_label"
]
}

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

200

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) [ items non-empty ]

Responses

Request samples

Payload

Content type

application/json

{"value": ["OVERNIGHT",
"2_DAY"
]
}

Response samples

200
422

Content type

application/json

null