TRtrackstarhq

Request an Integration

Changed on

Ask us to build an integration we don't support yet. We open a ticket and follow up with you.

post/integration-requests

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/integration-requests
  • Auth
    none required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

Request body

integration_type'wms' | 'cart' | 'carrier' required
integration_namestring required
integration_contact_emailstring nullable
brand_namestring nullable
brand_contact_emailstring nullable
api_docs_urlstring nullable
api_docs_via_emailboolean
flowsstring[] required

The flows you need from this integration. For wms, one of: read_inventory, read_products, read_orders, read_inbounds, read_returns, read_warehouses, create_order, cancel_order, create_product, create_inbound, create_return. For cart and carrier, the action names that type supports. Pass "not_sure" if you do not know yet, and we will follow up. Call GET /integration-requests/flows for the current list.

prod_creds_urlstring nullable
sandbox_creds_urlstring nullable
notesstring nullable

Example request

{
  "integration_type": "carrier",
  "integration_name": "integration_name",
  "integration_contact_email": "integration_contact_email",
  "brand_name": "brand_name",
  "brand_contact_email": "brand_contact_email",
  "api_docs_url": "api_docs_url",
  "api_docs_via_email": true,
  "flows": [
    "read_orders",
    "read_inventory"
  ],
  "prod_creds_url": "prod_creds_url",
  "sandbox_creds_url": "sandbox_creds_url",
  "notes": "notes"
}

Response

Successful response

successboolean required

Example response

{
  "success": true
}

Changes