Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

connection
string
required

Body

application/json

How a 3PL connection works.

warehouse_map
object
required

The 3PL's warehouse id for each StockShift location it runs, by location id. A location left out goes back to the organization.

send_orders_on
enum<string>
required

confirm, or reserve to wait until the order holds its stock.

Available options:
confirm,
reserve
send_notices_on
enum<string>
required

sent, or approved for an organization that does not send its purchase orders.

Available options:
sent,
approved
snapshot_time
string
required

HH:MM, the 3PL's daily cut-off, when its stock is compared.

Pattern: ^([01]\d|2[0-3]):[0-5]\d$
snapshot_timezone
string
required

An IANA time zone, such as America/Denver.

tolerance_units
string
required

Differences of this many units or fewer are ignored.

Pattern: ^\d{1,12}(\.\d{1,6})?$

Response

ThirdPartyLogisticsSettingsResource

data
ThirdPartyLogisticsSettingsResource · object
required