# Ware2Go Documentation > Documentation for Ware2Go Append .md to any documentation page URL to get its markdown version. ## Guides - [Getting Started](https://developer.ware2go.io/docs/getting-started-1.md) - [Webhooks Setup](https://developer.ware2go.io/docs/webhooks-setup.md) - [Authentication](https://developer.ware2go.io/docs/authentication-1.md) ## API Reference - [Using the Try It Feature](https://developer.ware2go.io/reference/using-the-try-it-feature.md) - [Retrieves a bearer token for an API user](https://developer.ware2go.io/reference/post-v2-bearer-token.md) - [Get a paged list of orders](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-orders.md): Returns a paginated list of all outbound orders that meet the filter criteria that you define in the request body. - [Create a Sales Order](https://developer.ware2go.io/reference/post-v1-merchants-merchantid-orders.md): Creates and submits a new outbound order. Requires a valid order object in the request body. Do not include the 'orderId' attribute as the 'orderId' is generated after creating an order. - [Get details for a specific order.](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-order-orderid.md): Provide an `orderId` in the path to get details of a single order. - [Bulk Update OnHold Status](https://developer.ware2go.io/reference/put-v1-merchants-merchantid-orders-bulk-onhold.md): Updates the onHold status for multiple sales orders in a single request. This endpoint allows you to: - **Put orders on hold**: Provide the `onHold` object in the request body - **Set automatic release**: Include a `releaseDate` in the `onHold` object to automatically release orders on a specific hour - **Remove hold status**: Provide null as the `onHold` value in the request body The response will indicate which orders were successfully updated and which failed with error details. # Bulk Operations for Sales Orders Bulk operations allow you to efficiently update multiple sales orders in a single API request. ## Bulk OnHold Operations The **Bulk OnHold** endpoint (`PUT /v1/merchants/{merchantId}/orders/bulk`) manages the hold status of multiple orders. ### Use Cases | Operation | Description | Request Body Example | | ------------------------ | ------------------------------------------------------- | ----------------------------- | | **Put Orders on Hold** | Place multiple orders on hold to prevent fulfillment | Send non-null `onHold` object | | **Remove Hold Status** | Release multiple orders from hold to resume fulfillment | Send null `onHold` property | | **Scheduled Release** | Set holds to release automatically on a specific hour | Include `onHold.releaseDate` | ### Request Structure The request body requires: - `referenceIds`: Array of order reference IDs to update - `onHold` (nullable): Object containing hold configuration: null value clears any existing hold - `onHold.releaseDate` (optional): If present the hold is configured to end on the given hour ### Response Structure The response provides feedback about the bulk operation: - `errors`: Empty array indicating all orders succeeded - `meta`: Optional metadata about the operation ### Error Handling When an individual order fails to update, the operation continues processing other orders. Failed orders will appear in the `messages` array with: - **title**: Brief error description - **detail**: Detailed error message - **meta.salesOrderNumber**: The specific order that failed ### Example Workflows #### Hold orders until the hold is manually removed ```json { "referenceIds": ["ORDER-001", "ORDER-002", "ORDER-003"], "onHold": {} } ``` #### Hold orders until a specific hour in the future ```json { "referenceIds": ["ORDER-001", "ORDER-002", "ORDER-003"], "onHold": { "releaseDate": "2024-12-25T10:00:00Z" } } ``` #### Remove a hold from orders manually ```json { "referenceIds": ["ORDER-001", "ORDER-002", "ORDER-003"], "onHold": null } ``` - [Cancel Sales Order](https://developer.ware2go.io/reference/post-v1-merchants-merchantid-order-orderid.md): Cancel an existing order as long as picking has not started for the order. - [Add an attachment to a Sales Order](https://developer.ware2go.io/reference/post-v1-merchants-merchantid-orders-attachments.md): Adds an attachment to the specified outbound order. Requires a valid base64 encoded file in the request body. - [List Warehouse Orders](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-order-orderid-warehouse-orders.md): Get a list of warehouse orders for an existing sales order. - [Report Mispicks on an Order](https://developer.ware2go.io/reference/put-v1-merchants-merchantid-order-orderid-mispicks.md): Sets the mispicks on the outbound order and adds the MISPICK flag. - [Get a paged list of inventory](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-inventory.md) - [Create a Single Item in the Product Catalog](https://developer.ware2go.io/reference/post-v1-merchants-merchantid-inventory-skuid.md) - [Retrieve Detailed Information for a Specific Item](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-inventory-skuid.md) - [Edits a Specific Inventory SKU](https://developer.ware2go.io/reference/put-v1-merchants-merchantid-inventory-skuid.md) - [Get a paged list of Inbound Shipments](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-inbound_shipments.md): Returns all inbound shipments with the shipments List Object. Pages will contain up to 100 shipments. - [Create an Inbound Shipment](https://developer.ware2go.io/reference/post-v1-merchants-merchantid-inbound_shipments.md): Creates a new Inbound Shipment. - [Get details for a specific inbound shipment](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-inbound_shipments-shipmentid.md): Returns details about the shipment specified by the `{shipmentId}` set in the path parameters. - [Cancel Inbound Shipment](https://developer.ware2go.io/reference/post-v1-merchants-merchantid-inbound_shipments-shipmentid-cancel.md): Cancel an inbound shipment that was previously 'Processing'. Requires the specific shipment ID. - [Get a paged list of RMAs](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-rmas.md): Get a paged list of RMAs based on the filter selection. All query parameters are optional filters. - [Create an RMA](https://developer.ware2go.io/reference/post-v1-merchants-merchantid-rmas.md): Create an RMA. - [Get the details for a single RMA](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-rmas-rmanumber.md): Get the shipping label information for the RMA. If the RMA is accepted then the response will only include the RMA data. If the RMA includes an error, the RMA data will be returned, but the status value will be `ERROR` and the `errors` array will be filled from the inbound-shipments invalid RMA endpoint. - [Update the details for a single RMA](https://developer.ware2go.io/reference/put-v1-merchants-merchantid-rmas-rmanumber.md): Updates information about an existing RMA. When the update is successful the status of the RMA will be set to `OPEN`. The shippingSpeed will be set to the default value of `ECONOMY` if not otherwise specified. - [Cancel a single RMA](https://developer.ware2go.io/reference/post-rmas-rmanumber-cancel.md): Cancel an RMA - [Get the address labels for a specific RMA](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-rmas-rmanumber-labels.md): Get the shipping label information for the RMA. If the RMA is accepted but does not have a shipping label, the operation returns a success response with the shipping label as `NULL`. If the return is accepted and has an empty tracking number list, the operation will return an empty array for the tracking numbers. If the return has both an empty shipping label and an empty tracking number array it will return both an empty shipping label URL and an empty tracking number array. - [Get a paged list of active sales channel IDs.](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-sales_channels.md): Get a paged list of active sales channel IDs based on the merchantId path variable. - [Retrieves the Warehouse Matches for a Specific Merchant](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-matches.md) - [Get a paged list of tags.](https://developer.ware2go.io/reference/get-v1-merchants-merchantid-tags.md): Get a paged list of tags. - [Publish an Outbound Order status change event](https://developer.ware2go.io/reference/post-outbound-order-status-change.md): Publish an Outbound Orders status change event - [Publish an Product Catalog change event](https://developer.ware2go.io/reference/post-product-catalog-change.md): Publish an Product Catalog change event - [Publish an Inbound ASN change event](https://developer.ware2go.io/reference/post-inbound-asn-change.md): Publish an Inbound ASN change event - [Publish an Inbound RMA change event](https://developer.ware2go.io/reference/post-inbound-rma-change.md): Publish an Inbound RMA change event - [Get Organizations](https://developer.ware2go.io/reference/get-organizations.md) - [Create or Edit an Organization](https://developer.ware2go.io/reference/put-organizations-organizationid.md) - [Get Organization](https://developer.ware2go.io/reference/get-organizations-organizationid.md) - [Get Associated Warehouses for an Organization](https://developer.ware2go.io/reference/get-organizations-organizationid-matches.md) - [Create or Edit an Association between an Organization and a Warehouse](https://developer.ware2go.io/reference/put-organizations-organizationid-warehouses-warehouseid.md) - [Delete an Association between an Organization and a Warehouse](https://developer.ware2go.io/reference/delete-organizations-organizationid-warehouses-warehouseid.md) - [Check if external id is in use](https://developer.ware2go.io/reference/get-warehouses-externalwarehouseid.md) - [List Outbound Orders](https://developer.ware2go.io/reference/get-organizations-orders.md) - [Create or Edit a Outbound Order](https://developer.ware2go.io/reference/put-organizations-organizationid-orders-outboundordernumber.md) - [Get WarehouseOrders for Outbound Order](https://developer.ware2go.io/reference/get-organizations-organizationid-warehouse-orders-outboundordernumber.md) - [Cancel Order](https://developer.ware2go.io/reference/cancel-outbound-order.md) - [Schedule order for Sync](https://developer.ware2go.io/reference/post-organizations-organizationid-order-ordernumber-sync.md) - [List Order Sync Statuses](https://developer.ware2go.io/reference/get-organizations-orders-sync.md) - [Batch schedule orders for Sync](https://developer.ware2go.io/reference/post-organizations-organizationid-orders-sync.md) - [Update TMS Booking Details for Freight Order](https://developer.ware2go.io/reference/put-organizations-organizationid-orders-outboundordernumber-warehouse_orders-warehouseordernumber-tms-booking_details.md) - [Upload Document for Order](https://developer.ware2go.io/reference/put-organizations-organizationid-orders-outboundordernumber-upload_document.md) - [Get Catalog SKUs](https://developer.ware2go.io/reference/get-organizations-catalog.md) - [Create or Edit a SKU](https://developer.ware2go.io/reference/put-organizations-organizationid-catalog-skuid.md) - [Get SKU](https://developer.ware2go.io/reference/get-organizations-organizationid-catalog-skuid.md) - [Get Inventory Transactions](https://developer.ware2go.io/reference/get-organizations-organizationid-inventory-transactions.md) - [Get Inventory Stats By SKU](https://developer.ware2go.io/reference/get-organizations-organizationid-inventory-stats-by-sku.md) - [Get Inventory Stats By SKU and Warehouse](https://developer.ware2go.io/reference/get-organizations-organizationid-inventory-stats-by-sku-warehouse.md) - [Get Inventory Stats By SKU per Warehouse](https://developer.ware2go.io/reference/get-organizations-organizationid-inventory-stats-by-sku-warehouse-warehouseid.md) - [Get Inventory Stats Grouped By SKU, Warehouse And Lot](https://developer.ware2go.io/reference/get-organizations-organizationid-inventory-stats-by-warehouse-lot-warehouseid.md) - [Get Inventory Stats Grouped By SKU and Lot per Warehouse](https://developer.ware2go.io/reference/get-organizations-organizationid-inventory-stats-by-warehouse-lot.md) - [Get Inventory Holds by Organization](https://developer.ware2go.io/reference/get-organizations-organizationid-inventory-holds.md) - [List Cycle Counts](https://developer.ware2go.io/reference/get-organization-warehouse-cycle-counts.md) - [schedule an inventory cycle count](https://developer.ware2go.io/reference/post-organization-warehouse-cycle-count.md) - [Get Cycle Count Details](https://developer.ware2go.io/reference/get-organizations-organizationid-warehouse-warehouseid-cyclecounts-cyclecountid.md) - [Get Location Cycle Count Details](https://developer.ware2go.io/reference/get-organizations-organizationid-warehouse-warehouseid-cyclecounts-cyclecountid-locations-locationid.md) - [Get ASNs](https://developer.ware2go.io/reference/get-organizations-asns.md) - [Create or Edit an ASN](https://developer.ware2go.io/reference/put-organizations-organizationid-asns-asnnumber.md) - [Get ASN](https://developer.ware2go.io/reference/get-organizations-organizationid-asns-asnnumber.md) - [Cancel ASN](https://developer.ware2go.io/reference/cancel-asn.md) - [Get RMAs](https://developer.ware2go.io/reference/get-organizations-rmas.md) - [Create or Edit an RMA](https://developer.ware2go.io/reference/put-organizations-organizationid-rmas-rmanumber.md) - [Get RMA](https://developer.ware2go.io/reference/get-organizations-organizationid-rmas-rmanumber.md) - [Cancel RMA](https://developer.ware2go.io/reference/cancel-rma.md) - [Update WarehouseOrders](https://developer.ware2go.io/reference/put-orders.md) - [Book TMS Freight Shipment](https://developer.ware2go.io/reference/put-orders-tms-book.md) - [Cancel Booked TMS Shipment for Warehouse Order](https://developer.ware2go.io/reference/put-orders-tms-cancel.md) - [Update SKU Dimensions](https://developer.ware2go.io/reference/put-catalog-dimensions.md) - [Create an Inventory Transaction](https://developer.ware2go.io/reference/post-inventory-transaction.md) - [Update Inventory Stats Grouped by SKU and Warehouse](https://developer.ware2go.io/reference/put-inventory-stats-by-sku-warehouse.md) - [Update Inventory Stats Grouped by SKU, Warehouse, and Lot](https://developer.ware2go.io/reference/put-inventory-stats-by-warehouse-lot.md) - [Receive updates about the status of inventory cycle counts](https://developer.ware2go.io/reference/put_v1-inventory-cycle-counts.md) - [Receive updates about the results of inventory cycle counts at a location](https://developer.ware2go.io/reference/put_v1-inventory-location-cycle-counts.md) - [Update an ASN](https://developer.ware2go.io/reference/put-asns-asnnumber.md) - [Update an RMA](https://developer.ware2go.io/reference/put-rmas-rmanumber.md) - [Create a Shipment](https://developer.ware2go.io/reference/create-shipment.md): Adds a shipment to the CommerceVu platform. - [Shipment Summary](https://developer.ware2go.io/reference/get-shipment-summary.md): Returns a list of all shipments in the CommerceVu network. - [Shipment Details](https://developer.ware2go.io/reference/get-shipment-details.md): Returns all of the package details for a specific shipment. ## Recipes - [Anatomy of a Kit To Stock Inbound Shipment](https://developer.ware2go.io/recipes/anatomy-of-a-kit-to-stock-inbound-shipment.md) - [Anatomy of a Kit To Stock Work Order](https://developer.ware2go.io/recipes/anatomy-of-a-kit-to-stock-work-order.md) - [Anatomy of an FBA Sales Order](https://developer.ware2go.io/recipes/anatomy-of-an-fba-sales-order.md) - [Anatomy of an Other Inbound Shipment](https://developer.ware2go.io/recipes/anatomy-of-an-other-inbound-shipment.md) - [Anatomy of an Other Work Order](https://developer.ware2go.io/recipes/anatomy-of-an-other-work-order.md)