Put Channel Locations

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

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.

Replaces all configured locations on a MLI channel. Channel must be MLI otherwise a 400 Bad Request is returned.

Request

Bodyapplication/json

channelLocationsarray[ChannelLocationWritable]

externalChannelIdstringrequired

The identifier for this location as defined on the external channel.

sourceIdinteger (int32)

ID of the Source connected to this location. May be null if the source has been removed. Ownership will be confirmed if non-null.

namestringrequired

A display name for the location.

minimumQuantityinteger (int32)

The minimum quantity threshold for this location. Must be null or greater than or equal to 1.

missingAtstring (date-time)

Timestamp of when the location was last detected as missing from the external channel, if applicable.

metadatastring

Optional metadata associated with the location.

Example request

put/channel/{id}/locations

curl -X PUT "https://api.flxpoint.com/channel/{id}/locations" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
         "channelLocations": [
           {
             "externalChannelId": "string",
             "sourceId": 0,
             "name": "string",
             "minimumQuantity": 0,
             "missingAt": "2019-08-24T14:15:22Z",
             "metadata": "string"
           }
         ]
       }'

Example body · application/json

{
  "channelLocations": [
    {
      "externalChannelId": "string",
      "sourceId": 0,
      "name": "string",
      "minimumQuantity": 0,
      "missingAt": "2019-08-24T14:15:22Z",
      "metadata": "string"
    }
  ]
}

Responses

200OKapplication/json

channelLocationsarray[ChannelLocation]

externalChannelIdstringrequired

The identifier for this location as defined on the external channel.

sourceIdinteger (int32)

ID of the Source connected to this location. May be null if the source has been removed. Ownership will be confirmed if non-null.

namestringrequired

A display name for the location.

minimumQuantityinteger (int32)

The minimum quantity threshold for this location. Must be null or greater than or equal to 1.

missingAtstring (date-time)

Timestamp of when the location was last detected as missing from the external channel, if applicable.

metadatastring

Optional metadata associated with the location.

Example response

{
  "channelLocations": [
    {
      "externalChannelId": "string",
      "sourceId": 0,
      "name": "string",
      "minimumQuantity": 0,
      "missingAt": "2019-08-24T14:15:22Z",
      "metadata": "string"
    }
  ]
}

400Bad Request

No schema documented for this status.

401Unauthorized

No schema documented for this status.

403Forbidden

No schema documented for this status.

404Not Found

No schema documented for this status.

OpenAPI fragment

{
  "put": {
    "summary": "Put Channel Locations",
    "description": "Replaces all configured locations on a MLI channel. Channel must be MLI otherwise a 400 Bad Request is returned.",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PutChannelLocationsRequest"
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PutChannelLocationsResponse"
            }
          }
        }
      },
      "400": {
        "description": "Bad Request"
      },
      "401": {
        "description": "Unauthorized"
      },
      "403": {
        "description": "Forbidden"
      },
      "404": {
        "description": "Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight