Put Channel

puthttps://api.flxpoint.com/channel/{id}

Use this when you want to replace channel data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Put an updated channel. Requires an account level token.

Request

Bodyapplication/json

namestringrequired

Channel Name

descriptionstring

Channel Description

primaryboolean

listingStrategyChannelListingStrategyrequired

The strategy used to manage listing pricing and quantity on the channel. -`single` = Single Vendor -`best` = Best Vendor -`mli` = Multi-Location Inventory

allowedsinglebestmli

pricingStrategyChannelPricingStrategy

Only applicable when `listingStrategy = mli`. Determines how prices should be aggregated or set based on the connected sources of the channel locations

allowedlowestaveragehighest

pricingFactorChannelPricingFactorrequired

Only applicable when `listingStrategy = best`. When comparing costs across sources/vendors should the dropship fee and shipping costs be included in the comparison that ultimately selected which source/vendor has the lowest cost? If so select total, if not select item.

allowedtotalitem

default "total"

pricingMarkupChannelPricingMarkuprequired

Should basic, advanced, or no pricing controls be applied.

allowedbasicadvancednone

default "basic"

quantityAggregationboolean

Only applicable when using a pricing strategy of `best`. This denotes that quantity should be aggregated from all relevant sources instead of just the `best` source.

channelInvoiceReceiptOptionIdinteger

invoiceReceiptAccountCustomAlertIdinteger

paymentCollectionboolean

default true

channelInvoiceDefaultStatusPaymentStatus

allowedNot AuthorizedAuthorizedPaidDeferredRefundedCreditedAwaiting ClearanceDeclinedRefund PendingRefund Failed

channelInvoiceCcstring

pricingWorkflowEventIdinteger

The ID of the Listing Price & Quantity Workflow for the Channel.

autoGeneratePoOnImportboolean

A setting that enables auto-generation of PO/FRs upon Order Import from the Channel.

default false

listingStatusWorkflowEventIdinteger

The ID of the Listing Status Workflow for the Channel.

allowBackorderboolean

listingBuilderMappingTemplateIdinteger

inStoreOrderboolean

listPriceProtectionboolean

Indicates whether price protection is applied to the listing. When true, the listing will not be eligible to sync to channels because either the price is below or equal to cost, the cost is missing, or the listing has no linked inventories.

Example request

put/channel/{id}

curl -X PUT "https://api.flxpoint.com/channel/{id}" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "name": "string",
         "description": "string",
         "primary": true,
         "listingStrategy": "single",
         "pricingStrategy": "lowest",
         "pricingFactor": "total",
         "pricingMarkup": "basic",
         "quantityAggregation": true,
         "channelInvoiceReceiptOptionId": 0,
         "invoiceReceiptAccountCustomAlertId": 0,
         "paymentCollection": true,
         "channelInvoiceDefaultStatus": "Not Authorized",
         "channelInvoiceCc": "string",
         "pricingWorkflowEventId": 0,
         "autoGeneratePoOnImport": true,
         "listingStatusWorkflowEventId": 0,
         "allowBackorder": true,
         "listingBuilderMappingTemplateId": 0,
         "inStoreOrder": true,
         "listPriceProtection": true
       }'

Example body · application/json

{
  "name": "string",
  "description": "string",
  "primary": true,
  "listingStrategy": "single",
  "pricingStrategy": "lowest",
  "pricingFactor": "total",
  "pricingMarkup": "basic",
  "quantityAggregation": true,
  "channelInvoiceReceiptOptionId": 0,
  "invoiceReceiptAccountCustomAlertId": 0,
  "paymentCollection": true,
  "channelInvoiceDefaultStatus": "Not Authorized",
  "channelInvoiceCc": "string",
  "pricingWorkflowEventId": 0,
  "autoGeneratePoOnImport": true,
  "listingStatusWorkflowEventId": 0,
  "allowBackorder": true,
  "listingBuilderMappingTemplateId": 0,
  "inStoreOrder": true,
  "listPriceProtection": true
}

Responses

200OKapplication/json