Skip to main content

Create Instance

POST 
/api/shipbob

Connect a new ShipBob integration instance. The provided ShipBob Personal Access Token is stored encrypted, a per-instance webhook signing secret is generated, webhook subscriptions are registered, and an initial sync of fulfillment centers, shipping methods, products, and inventory is queued.

Authentication: Requires Bearer token.

Request Body:

  • name (string, required) — Unique display name for the instance.
  • connection_settings (object, required):
    • environment (string, required) — 'production' or 'sandbox'.
    • api_token (string, required) — ShipBob Personal Access Token.
    • channel_id (integer, optional) — ShipBob channel id to operate under.
    • channel_name (string, optional) — Display name of the channel.
  • settings (object, optional):
    • sync_start_date (date, optional) — Earliest order date to sync (Y-m-d).
    • auto_create_products (boolean, optional) — Auto-create SKU products from ShipBob products.
    • record_shipping_costs (boolean, optional, default: true) — Record shipping costs from shipments.
    • default_shipping_method (string, optional) — Fallback shipping method name.
  • is_automatic_sync_enabled (boolean, optional, default: true) — Enable automatic background syncing.

Request​

Responses​

Created

Response Headers
    Content-Type