GET /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
- addressValidationEndpoint string | null
  
  Address validation endpoint
- addressValidationFinalize boolean | null Required
  
  Address validation finalize
  
  Default value is false.
- aftershipError string | null Required
  
  Aftership error
  
  Values are skip or error. Default value is skip.
- allocateDraftSales string | null Required
  
  Allocate draft sales
  
  Values are enabled or disabled. Default value is enabled.
- allocatedShipments string | null Required
  
  Allocated shipments
  
  Values are allow or error. Default value is allow.
- automaticallyCancelSales boolean | null Required
  
  Automatically cancel orders within Onport if they are cancelled within your store. Any dropship purchase orders for the order will also be cancelled.
  
  Default value is true.
- automaticallyFinalizeSales boolean Required
  
  Automatically finalize sales
  
  Default value is true.
- automaticallyPublish boolean | null Required
  
  When publishing products, they'll be automatically available once added to your store. When unchecked, you'll first be able to edit the details in your channel before making them available.
  
  Default value is true.
- blendedPreference string | null Required
  
  Blended preference
  
  Values are dropship, inhouse, or routing. Default value is inhouse.
- bundleInventorySync string | null Required
  
  Bundle inventory sync
  
  Values are enabled or disabled. Default value is enabled.
- cacheRates Cache API responses for rates at checkout (seconds}integer(int32) | null
  
  To ensure faster response times during the checkout process, we have optimized our shipping rate and shipment splitting services. By enabling caching, you can experience faster page loading times. However, please note that enabling caching may temporarily affect the accuracy of shipping prices, as recent adjustments made by the marketplace may not be immediately reflected until the cache expires. If you encounter any discrepancies, change the value here or waiting for the cache to expire.
- checkDropshipAt string(date-time) | null
  
  Check dropship at
- checkoutString string | null
  
  Checkout string
- collectionEndpoint string | null
  
  Collection endpoint
- connectToFeed boolean | null
  
  When a new variant is imported from your store, Onport will automatically check to see if an item with the same SKU exists in an inventory feed. The inventory feed must also have the Automatically connect by SKU setting enabled.
- connectedAt string(date-time) | null
  
  Connected at
- createdAt string(date-time)
  
  Created at
- disableVariantInventorySync boolean | null
  
  Disable variant inventory sync
- dropshipAllowTags array[string] | null Required
  
  Dropship allow tags
  
  Default value is [] (empty).
- dropshipProviderId integer(int32) | null
  
  Dropship provider
- dropshipRouting string | null Required
  
  Dropship routing
  
  Values are default or custom. Default value is default.
- dropshipRoutingTags array[string] | null
  
  Dropship routing tags
- dropshipTags array[string] | null Required
  
  Dropship tags
  
  Default value is [] (empty).
- email string | null
  
  Email
- enableFreeShippingCountries boolean | null Required
  
  Enable free shipping countries
  
  Default value is false.
- enforceRefundLimits string | null Required
  
  Enforce refund limits
  
  Values are enabled or disabled. Default value is enabled.
- eoriNumber string | null
  
  Eori number
- exportToShipstation boolean | null
  
  Export to shipstation
- externalFulfillmentTrigger string | null Required
  
  External fulfillment trigger
  
  Values are onCreate, onTracking, or onTransaction. Default value is onCreate.
- finalizationDelay string | null Required
  
  If you prefer not to finalise sales immediately, you can set a delay for automatic finalisation, or choose 'Manual' to always finalise sales manually.
  
  Values are manual or 30. Default value is manual.
- forceConnectToFeed boolean | null Required
  
  Force connect to feed
  
  Default value is false.
- freeShippingCode string | null
  
  Free shipping code
- freeShippingCountries array[string] | null
  
  Free shipping countries
- freeShippingName string | null
  
  Free shipping name
- freeShippingOriginCountries array[string] | null
  
  Free shipping origin countries
- freeShippingOverride boolean | null
  
  Free shipping override
- freeShippingScope string | null Required
  
  Free shipping scope
  
  Values are all, domestic, or selected. Default value is all.
- freeShippingThreshold number | null
  
  Free shipping threshold
- hash object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Hash
  
  Hash
  
  Hash
  
  Hash
  
  Hash
  
  Hash
- hideWhenNoCostPrice boolean | null
  
  With this option enabled, Variants without a Cost Price will have their inventory level set as 0.
- id integer(int32)
  
  Id
- imageSync string | null Required
  
  Image sync
  
  Values are bidirectional, jetti, channel, or inventoryFeed. Default value is bidirectional.
- importChannelFulfillments string | null Required
  
  You might want to set this to 'disabled' if you are using Onport to create in-house labels.
  
  Values are enabled or disabled. Default value is enabled.
- importFromFeed boolean | null
  
  Import from feed
- importPaymentStatus string | null Required
  
  Import payment status
  
  Values are unpaid, partiallyPaid, or paid. Default value is paid.
- importProductsSeconds integer(int32) | null
  
  Import products seconds
- includeBackorderQuantity boolean | null Required
  
  Include backorder quantity
  
  Default value is true.
- includeSaleTags boolean | null Required
  
  Include sale tags
  
  Default value is false.
- inhouseBrandNames array[string] | null
  
  Inhouse brand names
- inventoryFeedRemoved string | null Required
  
  Inventory feed removed
  
  Values are all or partial. Default value is all.
- inventoryFeedUnpublish string | null Required
  
  Inventory feed unpublish
  
  Values are none, unpublish, or unavailable. Default value is none.
- inventorySync string | null Required
  
  Inventory sync
  
  Values are all, inventory_feeds, or none. Default value is all.
- inventorySyncTrigger string | null Required
  
  Control which triggers should send inventory updates to your channel.
  
  Values are all or inventoryFeeds. Default value is all.
- lockIso boolean | null Required
  
  Lock iso
  
  Default value is true.
- manualSaleItemRouting string | null Required
  
  Manual sale item routing
  
  Values are ignore or pause. Default value is ignore.
- maxShippingCost boolean | null
  
  Max shipping cost
- maxShippingCostThreshold number | null
  
  Max shipping cost threshold
- maximumExpectedShipping string | null
  
  Maximum expected shipping
  
  Values are enabled or disabled.
- maximumExpectedShippingDuration integer(int32) | null Required
  
  Maximum expected shipping duration
  
  Default value is 0.
- name string Required
  
  Name
- negativeStock string | null Required
  
  Negative stock
  
  Values are enabled or disabled. Default value is enabled.
- negativeStockLevel integer(int32) | null Required
  
  Negative stock level
  
  Default value is 0.
- noRatesError boolean | null Required
  
  No rates error
  
  Default value is false.
- optionValueTarget string | null Required
  
  Option value target
  
  Values are attributes, metaFields, or none. Default value is attributes.
- orderRouting string | null Required
  
  Order routing
  
  Values are automated, manual, or ignore. Default value is automated.
- orderRoutingEndpoint string | null
  
  Order routing endpoint
- oversellingPrevention string | null Required
  
  Overselling prevention
  
  Values are enabled or disabled. Default value is disabled.
- parentChannel string | null Required
  
  Parent channel
  
  Values are bigCommerce, custom, duoplane, elasticPath, magento, manual, salesforce, shopify, or wooCommerce. Default value is manual.
- pdfLegal string | null
  
  Pdf legal
- phone string | null
  
  Phone
- priceListId integer(int32) Required
  
  Price list
- productsImportedAt string(date-time) | null
  
  Products imported at
- publishAdditionalTags array[string] | null Required
  
  Publish additional tags
  
  Default value is ["jetti"].
- publishMetaFields boolean | null
  
  Publish meta fields
- publishProducts boolean | null Required
  
  Publish products
  
  Default value is true.
- publishProductsWithoutPrice boolean | null Required
  
  Publish products without price
  
  Default value is true.
- publishTags string | null Required
  
  Publish tags
  
  Values are all or none. Default value is all.
- publishThrottle string | null Required
  
  Publish throttle
  
  Values are product or channel. Default value is product.
- purchasePrefix string | null
  
  Purchase prefix
- purchaseStatusId integer(int32) | null
  
  Purchase status
- rateLogging boolean | null Required
  
  Rate logging
  
  Default value is false.
- requirePhoneNumber boolean | null Required
  
  Require phone number
  
  Default value is false.
- requireVendorName boolean | null
  
  Require vendor name
- reverseSplitShipping string | null Required
  
  This setting controls how shipping rates are distributed among vendors when reverse invoicing is enabled. Reverse invoicing occurs when the vendor invoices the customer instead of the marketplace.
  
  Values are full or split. Default value is full.
- routingPriorityOne string | null Required
  
  Routing priority one
  
  Values are none, country, costPrice, or inStock. Default value is inStock.
- routingPriorityThree string | null Required
  
  Routing priority three
  
  Values are none, country, costPrice, or inStock. Default value is none.
- routingPriorityTwo string | null Required
  
  Routing priority two
  
  Values are none, country, costPrice, or inStock. Default value is none.
- saleCustomFields array[string] | null
  
  Sale custom fields
- saleCustomFieldsScope string | null Required
  
  Sale custom fields scope
  
  Values are all, selected, or none. Default value is none.
- saleLogging boolean | null Required
  
  Sale logging
  
  Default value is false.
- saleLoggingEmail string | null Required
  
  Sale logging email
  
  Values are none, initial, or all. Default value is none.
- saleMetaFieldFilter array[string] | null
  
  Sale meta field filter
- saleMetaFields string | null Required
  
  Sale meta fields
  
  Values are all, selected, or none. Default value is none.
- salePrefix string | null
  
  Sale prefix
- sendShippingNotification boolean | null Required
  
  Send shipping notification
  
  Default value is true.
- shippingInvoiceTemplate string | null
  
  Shipping invoice template
- shipstationConnectedAt string(date-time) | null
  
  Shipstation connected at
- shipstationPassword string | null
  
  Shipstation password
- shipstationTags array[string] | null
  
  Shipstation tags
- shipstationUrl object | null | array | boolean | integer | number | string
  
  Any of:
  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
  
  Shipstation url
  
  Shipstation url
  
  Shipstation url
  
  Shipstation url
  
  Shipstation url
  
  Shipstation url
- shipstationUsername string | null
  
  Shipstation username
- skipLineItems array[string] | null Required
  
  Skip line items
  
  Default value is [] (empty).
- skipTags array[string] | null Required
  
  Skip tags
  
  Default value is [] (empty).
- skipVariantTags array[string] | null Required
  
  Skip variant tags
  
  Default value is [] (empty).
- splitShipping string | null Required
  
  Split shipping
  
  Values are quantity, value, equal, full, or first. Default value is full.
- syncAddressUpdates boolean | null Required
  
  Sync address updates
  
  Default value is true.
- syncCostPrices boolean | null Required
  
  Sync cost prices
  
  Default value is false.
- syncCustomerNotes boolean | null Required
  
  Sync customer notes
  
  Default value is true.
- syncImages boolean | null Required
  
  Sync images
  
  Default value is true.
- syncPricing boolean | null Required
  
  Sync pricing
  
  Default value is true.
- syncQuickbookSalesAutomatically boolean | null
  
  Sync quickbook sales automatically
- syncSingleVariantMetafields string | null Required
  
  Sync single variant metafields
  
  Values are product or variant. Default value is variant.
- syncWeightZero boolean | null Required
  
  Sync weight zero
  
  Default value is false.
- taxCalculation string | null Required
  
  Tax calculation
  
  Values are channel, taxRate, or taxjar. Default value is channel.
- taxId string | null
  
  Tax
- taxIncluded boolean Required
  
  Tax included
  
  Default value is true.
- taxRateId integer(int32) | null
  
  Tax rate
- taxShipping boolean Required
  
  Tax shipping
  
  Default value is true.
- unallocatedDropship string | null Required
  
  Unallocated dropship
  
  Values are ignore or pause. Default value is pause.
- unassignedSaleItems string | null Required
  
  Unassigned sale items
  
  Values are include, exclude, or block. Default value is include.
- unpublishNoInventory boolean | null Required
  
  Unpublish no inventory
  
  Default value is false.
- updatedAt string(date-time)
  
  Updated at
- useOrderRoutingEndpoint boolean | null Required
  
  Use order routing endpoint
  
  Default value is false.
- useVariantImage boolean | null Required
  
  When publishing products, variant images will also be uploaded, if available.
  
  Default value is false.
- variantImportScope string | null Required
  
  Variant import scope
  
  Values are product or mapping. Default value is product.
- variantLogging boolean | null Required
  
  Variant logging
  
  Default value is false.
- warehouseId integer(int32) Required
  
  Warehouse
- warehouseSync string | null Required
  
  Warehouse sync
  
  Values are default or all. Default value is default.
- weightUnit string | null Required
  
  Weight unit
  
  Values are g, kg, oz, or lb. Default value is g.

curl \
 -X GET http://api.example.com/v1/channels/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "addressValidationEndpoint": "string",
  "addressValidationFinalize": false,
  "aftershipError": "skip",
  "allocateDraftSales": "enabled",
  "allocatedShipments": "allow",
  "automaticallyCancelSales": true,
  "automaticallyFinalizeSales": true,
  "automaticallyPublish": true,
  "blendedPreference": "inhouse",
  "bundleInventorySync": "enabled",
  "cacheRates": 42,
  "checkDropshipAt": "2024-05-04T09:42:00+00:00",
  "checkoutString": "string",
  "collectionEndpoint": "string",
  "connectToFeed": true,
  "connectedAt": "2024-05-04T09:42:00+00:00",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "disableVariantInventorySync": true,
  "dropshipAllowTags": [],
  "dropshipProviderId": 42,
  "dropshipRouting": "default",
  "dropshipRoutingTags": [
    "string"
  ],
  "dropshipTags": [],
  "email": "string",
  "enableFreeShippingCountries": false,
  "enforceRefundLimits": "enabled",
  "eoriNumber": "string",
  "exportToShipstation": true,
  "externalFulfillmentTrigger": "onCreate",
  "finalizationDelay": "manual",
  "forceConnectToFeed": false,
  "freeShippingCode": "string",
  "freeShippingCountries": [
    "string"
  ],
  "freeShippingName": "string",
  "freeShippingOriginCountries": [
    "string"
  ],
  "freeShippingOverride": true,
  "freeShippingScope": "all",
  "freeShippingThreshold": 42.0,
  "hash": {},
  "hideWhenNoCostPrice": true,
  "id": 42,
  "imageSync": "bidirectional",
  "importChannelFulfillments": "enabled",
  "importFromFeed": true,
  "importPaymentStatus": "paid",
  "importProductsSeconds": 42,
  "includeBackorderQuantity": true,
  "includeSaleTags": false,
  "inhouseBrandNames": [
    "string"
  ],
  "inventoryFeedRemoved": "all",
  "inventoryFeedUnpublish": "none",
  "inventorySync": "all",
  "inventorySyncTrigger": "all",
  "lockIso": true,
  "manualSaleItemRouting": "ignore",
  "maxShippingCost": true,
  "maxShippingCostThreshold": 42.0,
  "maximumExpectedShipping": "enabled",
  "maximumExpectedShippingDuration": 0,
  "name": "string",
  "negativeStock": "enabled",
  "negativeStockLevel": 0,
  "noRatesError": false,
  "optionValueTarget": "attributes",
  "orderRouting": "automated",
  "orderRoutingEndpoint": "string",
  "oversellingPrevention": "disabled",
  "parentChannel": "manual",
  "pdfLegal": "string",
  "phone": "string",
  "priceListId": 42,
  "productsImportedAt": "2024-05-04T09:42:00+00:00",
  "publishAdditionalTags": [
    "jetti"
  ],
  "publishMetaFields": true,
  "publishProducts": true,
  "publishProductsWithoutPrice": true,
  "publishTags": "all",
  "publishThrottle": "product",
  "purchasePrefix": "string",
  "purchaseStatusId": 42,
  "rateLogging": false,
  "requirePhoneNumber": false,
  "requireVendorName": true,
  "reverseSplitShipping": "full",
  "routingPriorityOne": "inStock",
  "routingPriorityThree": "none",
  "routingPriorityTwo": "none",
  "saleCustomFields": [
    "string"
  ],
  "saleCustomFieldsScope": "none",
  "saleLogging": false,
  "saleLoggingEmail": "none",
  "saleMetaFieldFilter": [
    "string"
  ],
  "saleMetaFields": "none",
  "salePrefix": "string",
  "sendShippingNotification": true,
  "shippingInvoiceTemplate": "string",
  "shipstationConnectedAt": "2024-05-04T09:42:00+00:00",
  "shipstationPassword": "string",
  "shipstationTags": [
    "string"
  ],
  "shipstationUrl": {},
  "shipstationUsername": "string",
  "skipLineItems": [],
  "skipTags": [],
  "skipVariantTags": [],
  "splitShipping": "full",
  "syncAddressUpdates": true,
  "syncCostPrices": false,
  "syncCustomerNotes": true,
  "syncImages": true,
  "syncPricing": true,
  "syncQuickbookSalesAutomatically": true,
  "syncSingleVariantMetafields": "variant",
  "syncWeightZero": false,
  "taxCalculation": "channel",
  "taxId": "string",
  "taxIncluded": true,
  "taxRateId": 42,
  "taxShipping": true,
  "unallocatedDropship": "pause",
  "unassignedSaleItems": "include",
  "unpublishNoInventory": false,
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "useOrderRoutingEndpoint": false,
  "useVariantImage": false,
  "variantImportScope": "product",
  "variantLogging": false,
  "warehouseId": 42,
  "warehouseSync": "default",
  "weightUnit": "g"
}

GET /channels/{id}.json

Path parameters

Responses

hash object | null | array | boolean | integer | number | string

shipstationUrl object | null | array | boolean | integer | number | string