---
title: "Create Callback Subscription"
method: POST
path: "/openapi/seller/callback_subscriptions/"
tags: ["Seller Webhooks"]
---

# Create Callback Subscription

`POST /openapi/seller/callback_subscriptions/`

## Request

- Base URL: `https://base_url`
- URL: `https://base_url/openapi/seller/callback_subscriptions/`
- Auth: none declared

Create Callback Subscription.<br/>**Note**:- **Id** Returned in Response should be saved as this will be used to query/update.<br/>**Note**:- Creating a new callback subscription will deactivate any existing active subscription for the given callback_type

## Request body

- CallbackSubscription
  - `id` integer, required
  - `callback_type` 'CustomOrderStatusUpdate' | 'CustomProductStockUpdate' | 'InboundStatusUpdate' | 'InboundProductBulkUploadStatus' | 'InventoryProductBulkUploadStatus' | 'ReportDirectFile' | 'ReportDownloadLink' | 'ShipmentOrderStatusUpdate' | 'TransportVehicleTrackingUpdate' | 'ReturnOrderStatusUpdate', required: * `CustomOrderStatusUpdate` - CustomOrderStatusUpdate * `CustomProductStockUpdate` - CustomProductStockUpdate * `InboundStatusUpdate` - InboundStatusUpdate * `InboundProductBulkUploadStatus` - InboundProductBulkUploadStatus * `InventoryProductBulkUploadStatus` - InventoryProductBulkUploadStatus * `ReportDirectFile` - ReportDirectFile * `ReportDownloadLink` - ReportDownloadLink * `ShipmentOrderStatusUpdate` - ShipmentOrderStatusUpdate * `TransportVehicleTrackingUpdate` - TransportVehicleTrackingUpdate * `ReturnOrderStatusUpdate` - ReturnOrderStatusUpdate
  - `active` boolean
  - `url` string, uri, required
  - `auth_header_key` string, nullable
  - `auth_token` string, nullable
  - `headers` unknown
  - `send_single_event_in_callback` boolean, nullable

## Response `201`

- EnvelopedCallbackSubscription
  - `success` boolean
  - `data` CallbackSubscription, required
    - `id` integer, required
    - `callback_type` 'CustomOrderStatusUpdate' | 'CustomProductStockUpdate' | 'InboundStatusUpdate' | 'InboundProductBulkUploadStatus' | 'InventoryProductBulkUploadStatus' | 'ReportDirectFile' | 'ReportDownloadLink' | 'ShipmentOrderStatusUpdate' | 'TransportVehicleTrackingUpdate' | 'ReturnOrderStatusUpdate', required: * `CustomOrderStatusUpdate` - CustomOrderStatusUpdate * `CustomProductStockUpdate` - CustomProductStockUpdate * `InboundStatusUpdate` - InboundStatusUpdate * `InboundProductBulkUploadStatus` - InboundProductBulkUploadStatus * `InventoryProductBulkUploadStatus` - InventoryProductBulkUploadStatus * `ReportDirectFile` - ReportDirectFile * `ReportDownloadLink` - ReportDownloadLink * `ShipmentOrderStatusUpdate` - ShipmentOrderStatusUpdate * `TransportVehicleTrackingUpdate` - TransportVehicleTrackingUpdate * `ReturnOrderStatusUpdate` - ReturnOrderStatusUpdate
    - `active` boolean
    - `url` string, uri, required
    - `auth_header_key` string, nullable
    - `auth_token` string, nullable
    - `headers` unknown
    - `send_single_event_in_callback` boolean, nullable
  - `message` string, required

## Other responses

- `400`: Bad Request - Invalid input.
- `401`: Unauthorized - Invalid or expired credentials.
- `403`: Forbidden - You do not have permission to access this resource.
- `404`: Not Found - The requested resource does not exist.
- `500`: Internal Server Error - Unexpected error occurred.

---

[API](https://skmtc.dev/golocad/apis/locad-api.md) - [All operations](https://skmtc.dev/golocad/apis/locad-api/llms.txt) - [OpenAPI document](https://skmtc.dev/golocad/apis/locad-api/revisions/428200f33a81?raw)