GET /custom-channels/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- channelId integer(int32) | null
  
  Channel
- cloneOrderNotifications boolean | null Required
  
  Clone order notifications
  
  Default value is false.
- connectedAt string(date-time) | null
  
  Connected at
- createdAt string(date-time)
  
  Created at
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- fulfillmentEndpoint string | null
  
  Fulfillment endpoint
- googleFeedLocation string | null
  
  Google feed location
- id integer(int32)
  
  Id
- inventoryEndpoint string | null
  
  Inventory endpoint
- inventoryEndpointPrice boolean | null
  
  Inventory endpoint price
- name string Required
  
  Name
- postToChannelEndpoint string | null
  
  Post to channel endpoint
- priceEndpoint string | null
  
  Price endpoint
- priceEndpointInventory boolean | null
  
  Price endpoint inventory
- priceListEndpoint string | null
  
  Price list endpoint
- productsFeedFormat string | null Required
  
  Products feed format
  
  Values are custom, dreamingCode, or webhook. Default value is custom.
- publishingAcknowledgement string | null Required
  
  In Real-Time Mode (sync), your integrations will expect immediate responses with necessary identifiers for variant publications, ensuring swift acknowledgment and enabling instant updates. Choose Deferred Mode (async) to allow variants to remain in an acknowledging state until manually acknowledged, delaying updates and providing flexibility for asynchronous workflows.
  
  Values are sync or async. Default value is sync.
- publishingEndpoint string | null
  
  Publishing endpoint
- resourceLocation string | null
  
  Resource location
- salesFeedFormat string | null Required
  
  Sales feed format
  
  Values are custom, shipStation, or webhook. Default value is custom.
- updatedAt string(date-time)
  
  Updated at
- webhookHash string | null
  
  Aa custom hash value to include in the outbound webhook requests. This value will be included in the "onport-hash" or "jetti-hash" header

curl \
 --request GET 'http://api.example.com/v1/custom-channels/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "channelId": 42,
  "cloneOrderNotifications": false,
  "connectedAt": "2025-05-04T09:42:00Z",
  "createdAt": "2025-05-04T09:42:00Z",
  "enabled": true,
  "fulfillmentEndpoint": "string",
  "googleFeedLocation": "string",
  "id": 42,
  "inventoryEndpoint": "string",
  "inventoryEndpointPrice": true,
  "name": "string",
  "postToChannelEndpoint": "string",
  "priceEndpoint": "string",
  "priceEndpointInventory": true,
  "priceListEndpoint": "string",
  "productsFeedFormat": "custom",
  "publishingAcknowledgement": "sync",
  "publishingEndpoint": "string",
  "resourceLocation": "string",
  "salesFeedFormat": "custom",
  "updatedAt": "2025-05-04T09:42:00Z",
  "webhookHash": "string"
}