openapi: 3.2.0 info: title: Shiprocket Channels API version: v1 description: 'Shiprocket''s public REST API (v1/external) for eCommerce shipping and order management: authentication, order create/update/cancel/import, courier serviceability and AWB assignment, pickup scheduling, labels/manifests/invoices, shipment tracking, NDR actions, returns and exchanges, hyperlocal and international shipping, products, listings, channels, inventory, countries/postcodes, wallet balance, statements and discrepancies.' termsOfService: https://www.shiprocket.in/terms-conditions/ contact: name: Shiprocket API integration support email: integration@shiprocket.com url: https://apidocs.shiprocket.in/ servers: - url: https://apiv2.shiprocket.in description: Production security: - bearerAuth: [] tags: - name: Channels description: 'Use this API to get details about all the integrated channels in your Shiprocket account, including channel id. This channel id can be used to select or specify a custom channel at the time of order creation.' paths: /v1/external/channels: get: summary: Get Integrated Channel Details description: 'This API shows a list of all the channels that have already been integrated with your Shiprocket account. No parameters are required to access this API.' operationId: getIntegratedChannelDetails tags: - Channels responses: '200': description: Successful Call content: application/json: examples: Successful-Call: value: data: - id: 76893 name: CUSTOM status: Active connection_response: null channel_updated_at: '2018-05-24 11:55:28' status_code: 1 settings: dimensions: 0x0x0 weight: 0 order_status: '' auth: [] connection: 1 orders_sync: 0 inventory_sync: 0 catalog_sync: 0 orders_synced_on: Not Available inventory_synced_on: Not Available base_channel_code: CS base_channel: id: 4 name: MANUAL code: CS type: Carts logo: custom.png settings_sample: name: Channels Settings help: '' settings: brand_name: code: brand_name name: Brand Name placeholder: Your brand name type: text brand_logo: code: brand_logo name: Brand Logo placeholder: Your brand logo type: file auth_sample: [] description: Manual channel catalog_synced_on: 31 Jul 12:49 PM order_status_mapper: '' payment_status_mapper: '' brand_name: '' brand_logo: '' schema: type: object properties: data: type: array items: type: object properties: id: type: integer name: type: string status: type: string connection_response: {} channel_updated_at: type: string status_code: type: integer settings: type: object properties: dimensions: type: string weight: type: integer order_status: type: string auth: type: array items: {} connection: type: integer orders_sync: type: integer inventory_sync: type: integer catalog_sync: type: integer orders_synced_on: type: string inventory_synced_on: type: string base_channel_code: type: string base_channel: type: object properties: id: type: integer name: type: string code: type: string type: type: string logo: type: string settings_sample: type: object properties: name: type: string help: type: string settings: type: object properties: brand_name: type: object properties: code: type: string name: type: string placeholder: type: string type: type: string brand_logo: type: object properties: code: type: string name: type: string placeholder: type: string type: type: string auth_sample: type: array items: {} description: type: string catalog_synced_on: type: string order_status_mapper: type: string payment_status_mapper: type: string brand_name: type: string brand_logo: type: string '404': description: Wrong Endpoint Name content: application/json: examples: Wrong-Endpoint-Name: value: message: 404 Not Found status_code: 404 schema: type: object properties: message: type: string status_code: type: integer post: summary: Create Custom Channel description: 'Creates a new manual (custom) channel in the seller''s Shiprocket account. Pre-condition: This endpoint is gated. Your account must be allow-listed for "Channel Creation by API" by the Shiprocket Tech Support / KAM team before it will work. Request body Error responses 401 Unauthorized — Missing or invalid bearer token. 403 Forbidden — "Channel Creation by API" flag is not enabled for your account, or channel limit reached. 422 Unprocessable Entity — Validation failure (name missing, name > 12 chars, name already exists, or brand_name > 50 chars). Notes Default order-status mapping is applied automatically (matches the canonical mapping used when you create a manual channel from the Shiprocket dashboard).' operationId: createCustomChannel tags: - Channels requestBody: content: application/json: schema: type: object properties: name: type: string brand_name: type: string example: name: MANUAL-25149 brand_name: SIORA-12 responses: '200': description: Successful Call content: application/json: examples: Successful-Call: value: channel_id: 123456 name: MANUAL-25149 brand_name: SIORA-12 base_channel_code: CUSTOM status: 1 company_id: 25149 created_at: '2026-04-29 12:34:56' schema: type: object properties: channel_id: type: integer name: type: string brand_name: type: string base_channel_code: type: string status: type: integer company_id: type: integer created_at: type: string components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'JWT obtained from POST /v1/external/auth/login using an API user email + password (Settings > API > Add New API User). The token is valid for 10 days; send it as Authorization: Bearer .' externalDocs: url: https://apidocs.shiprocket.in/ description: Shiprocket API documentation (Postman documenter) x-generated-from: type: postman-collection url: https://apidocs.shiprocket.in/api/collections/8407119/SzYW1zB2?environment=8407119-3ebd70ec-0118-4aa7-a886-4802616014f5&segregateAuth=true&versionTag=latest documenter: https://apidocs.shiprocket.in/ collection_id: f5af337c-69fc-49c7-8418-e2f6ee461674 generated: '2026-09-18' method: generated note: Faithful conversion; schemas inferred from published parameter tables and examples.