POST /channel-dropship-locations.json

POST /channel-dropship-locations.json
application/json

Body Required

  • channelId integer(int32) Required

    Select the channel you are syncing the inventory with.

  • dropshipLocationId integer(int32) Required

    Dropship location

  • externalId string | null

    The external ID of your marketplace location that you wish to sync with the mapped vendor locations. The external ID represents the unique identifier assigned to your marketplace location, such as the Shopify Store ID. By providing the correct external ID, the inventory from the mapped vendor locations will be synchronized and associated with your marketplace location. This ensures accurate tracking and management of inventory across platforms.

    Having the correct external ID is essential for the successful synchronization of inventory between your marketplace and the vendor's locations. Make sure to double-check the accuracy of the ID before proceeding.

  • Please select the ID of the vendor's inventory location that you wish to map to this channel location. The inventory location ID is a unique identifier provided by the vendor to represent their specific inventory locations. To find the inventory location ID, you can refer to the vendor's platform-specific documentation. If you are unsure about the location ID or need further assistance, please reach out to the vendor directly for clarification and support.

    Remember, selecting the correct inventory location ID is crucial for accurate mapping of your channel location to the vendor's inventory, so please ensure you have the correct information before proceeding.For example, if you add the location 123 and 456 here, the inventory quantities from both locations will be combined and synced to your channel location.

  • inventoryFeedLocationNames array[string] | null

    Please enter the name of the location that you want to map to this channel. The location name is used to identify the specific physical or virtual location associated with your channel. Ensure that you enter the accurate name of the location to ensure proper mapping and synchronization with the vendor's inventory system.

    If you are unsure about the location name or need further information, please consult the vendor's documentation or contact their support team for guidance. Note that the location name may vary depending on the vendor's platform. Refer to the vendor-specific documentation to understand how the location name should be formatted and what information should be included.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • channelId integer(int32) Required

      Select the channel you are syncing the inventory with.

    • createdAt string(date-time)

      Created at

    • dropshipLocationId integer(int32) Required

      Dropship location

    • externalId string | null

      The external ID of your marketplace location that you wish to sync with the mapped vendor locations. The external ID represents the unique identifier assigned to your marketplace location, such as the Shopify Store ID. By providing the correct external ID, the inventory from the mapped vendor locations will be synchronized and associated with your marketplace location. This ensures accurate tracking and management of inventory across platforms.

      Having the correct external ID is essential for the successful synchronization of inventory between your marketplace and the vendor's locations. Make sure to double-check the accuracy of the ID before proceeding.

    • id integer(int32)

      Id

    • Please select the ID of the vendor's inventory location that you wish to map to this channel location. The inventory location ID is a unique identifier provided by the vendor to represent their specific inventory locations. To find the inventory location ID, you can refer to the vendor's platform-specific documentation. If you are unsure about the location ID or need further assistance, please reach out to the vendor directly for clarification and support.

      Remember, selecting the correct inventory location ID is crucial for accurate mapping of your channel location to the vendor's inventory, so please ensure you have the correct information before proceeding.For example, if you add the location 123 and 456 here, the inventory quantities from both locations will be combined and synced to your channel location.

    • inventoryFeedLocationNames array[string] | null

      Please enter the name of the location that you want to map to this channel. The location name is used to identify the specific physical or virtual location associated with your channel. Ensure that you enter the accurate name of the location to ensure proper mapping and synchronization with the vendor's inventory system.

      If you are unsure about the location name or need further information, please consult the vendor's documentation or contact their support team for guidance. Note that the location name may vary depending on the vendor's platform. Refer to the vendor-specific documentation to understand how the location name should be formatted and what information should be included.

    • updatedAt string(date-time)

      Updated at

POST /channel-dropship-locations.json
curl \
 -X POST http://api.example.com/v1/channel-dropship-locations.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"channelId":42,"dropshipLocationId":42,"externalId":"string","inventoryFeedLocationExternalIds":["string"],"inventoryFeedLocationNames":["string"]}'
Request example
{
  "channelId": 42,
  "dropshipLocationId": 42,
  "externalId": "string",
  "inventoryFeedLocationExternalIds": [
    "string"
  ],
  "inventoryFeedLocationNames": [
    "string"
  ]
}
Response examples (200)
{
  "channelId": 42,
  "createdAt": "2024-05-04T09:42:00+00:00",
  "dropshipLocationId": 42,
  "externalId": "string",
  "id": 42,
  "inventoryFeedLocationExternalIds": [
    "string"
  ],
  "inventoryFeedLocationNames": [
    "string"
  ],
  "updatedAt": "2024-05-04T09:42:00+00:00"
}