API Fields (Batch)

This document provides a breakdown of Batch API Fields in ShipWise.

Definitions

orders: Holds arguments for what orders to attach to this batch.

orders.id: ShipWise internal order Id, returned during order create. Either id or market order number has to be used for linking orders.

orders.marketOrderid: Order number generated by shipping warehouse, order manager, or marketplace. Sales channel information is required if creating a batch with this field.

orders.salesChannel: Holds arguments for what market the order originated from.

orders.salesChannel.id: Internal value set by ShipWise.

orders.salesChannel.name: Name of the marketplace the order originated from.

orders.salesChannel.linkId: Marketplace/integration link Id is an internal value for ShipWise. This value can be pulled from order data or /Channel endpoint.

orders.salesChannel.subchannelId: Marketplace/integration link Id is an internal value for ShipWise. This value can be pulled from order data or /Channel endpoint.

orders.salesChannel.description: Name of the specific marketplace/order manager integration.