Skip to main content

Connect

POST 
/v1/brands/:brandId/warehouses

Connect a brand to a warehouse provider using provider and brandIdInWarehouse. Provider-specific credentials or an OAuth URL complete the flow.

Requires inventory.write.

Request and response fields at a glance
  • Path parameters: brandId (integer, required).
  • Request body (application/json): provider (string, required), brandIdInWarehouse (string, required), apiKey (string), apiSecret (string), clientId (string), certificateId (string), receivesChannelOrders (boolean).
  • 201 response (application/json): oauthUrl (string), id (number, required), brandId (number, required), warehouseId (number, required), brandIdInWarehouse (string, required), dashboardUrl (string), connectJobId (string), connectJobKind (string), clientId (string), certificateId (string), tokenExpiry (string), receivesChannelOrders (boolean, required), isFulfillmentFeedEnabled (boolean, required), lastFulfillmentEventAt (string), status (string, required), createdAt (string, required), updatedAt (string, required), warehouse (object).

Request​