# REST API The REST API is a programmatic communications interface designed to enable Wineshipping’s customer and partner applications to natively transmit and manage shipping orders, inventory, package tracking, and other key business and operational functions.

Try out the API methods in in our [postman collection](https://wineshipping.postman.co/workspace/Wineshipping-API---Public~2cf99dd4-d2b7-4e17-a992-fc2cbf33a9dd/collection/31241720-e423159e-ecde-4241-bd43-44c5609a78e3).

Version: 3.1.3 License: Proprietary ## Servers Test ``` https://api-test.wineshipping.com/v3 ``` Production ``` https://api.wineshipping.com/v3 ``` ## Download OpenAPI description - [REST API](https://developer.wineshipping.com/_bundle/api/v3.1/openapi.yaml) ## Fulfillment - [POST /api/SalesOrder/CreateSalesOrder](https://developer.wineshipping.com/api/v3.1/openapi/fulfillment/createsalesorder.md): Successful execution of this method will generate a new shipment order in Wineshipping's system and will return a transaction reference identifier. Store this identifier back into your system for refe - [POST /api/SalesOrder/UpdateSalesOrder](https://developer.wineshipping.com/api/v3.1/openapi/fulfillment/updatesalesorder.md): Use this operation to update an existing open sales order. If you are using the IsCancelOnly flag, please migrate to use the [Cancel Sales Order](CancelSalesOrder) method instead. - [POST /api/SalesOrder/CancelSalesOrder](https://developer.wineshipping.com/api/v3.1/openapi/fulfillment/cancelsalesorder.md): Use this operation to cancel an existing open sales order. Successful execution of this method will cancel the sales order in Wineshipping system. If the order cannot be cancelled for some reason stan - [POST /api/SalesOrder/GetOrdersOnHold](https://developer.wineshipping.com/api/v3.1/openapi/fulfillment/getordersonhold.md): Use this operation to retrieve a list of on-hold orders for a customer. Successful execution of this method will generate a list of on hold orders from Wineshipping's system and if no orders are on ho - [POST /api/SalesOrder/GetReturns](https://developer.wineshipping.com/api/v3.1/openapi/fulfillment/getreturns.md): Use this operation to retrieve a list of return sales orders for a customer. Successful execution of this method will generate a list of returns from Wineshipping system. - [POST /api/SalesOrder/GenerateJitLabel](https://developer.wineshipping.com/api/v3.1/openapi/fulfillment/generatejitlabel.md): This method is used to generate a Just-In-Time shipping label for your Orders. It can be used to print just a label or a packingslip and a label. You can choose from PDF or PNG format. - [POST /api/SalesOrder/BatchSalesOrder](https://developer.wineshipping.com/api/v3.1/openapi/fulfillment/batchsalesorder.md): This operation is used to create new orders in batch. The response will contain order creation status for each order along with individual order transaction number for reference later in the event the ## Inventory - [POST /api/InventoryMovement/CreatePurchaseOrder](https://developer.wineshipping.com/api/v3.1/openapi/inventory/createpurchaseorder.md): This operation is used to create an inbound inventory request. Successful execution of this operation will generate a new purchase order in Wineshipping system. The inbound request can be a pickup fro - [POST /api/InventoryMovement/UpdatePurchaseOrder](https://developer.wineshipping.com/api/v3.1/openapi/inventory/updatepurchaseorder.md): Update an existing inventory receipt request - [POST /api/InventoryMovement/CancelPurchaseOrder](https://developer.wineshipping.com/api/v3.1/openapi/inventory/cancelpurchaseorder.md): This operation is used to cancel a purchase order request. A transaction reference identifier is required to post using this operation. A transaction reference identifier will be returned upon use of - [POST /api/InventoryMovement/CreateTransferOrder](https://developer.wineshipping.com/api/v3.1/openapi/inventory/createtransferorder.md): This operation is used to create a inventory transfer request between two Wineshipping managed inventory locations. Successful execution of this operation will generate a new transfer order in Wineshi - [POST /api/InventoryMovement/UpdateTransferOrder](https://developer.wineshipping.com/api/v3.1/openapi/inventory/updatetransferorder.md): Use this operation to update an existing open transfer order. Successful execution of this method will update an open transfer order in Wineshipping system. If for some reason the order cannot be upda - [POST /api/InventoryMovement/CancelTransferOrder](https://developer.wineshipping.com/api/v3.1/openapi/inventory/canceltransferorder.md): This operation is used to cancel a transfer order request. A transaction reference identifier is required to post using this operation. A transaction reference identifier will be returned upon use of - [POST /api/Inventory/GetTransactions](https://developer.wineshipping.com/api/v3.1/openapi/inventory/getinventorytransactions.md): This method allows a customer to retrieve inventory transactions. Inventory transactions include Sales Orders, Purchase Orders, Transfer In, Transfer Out, Production Lines, Inventory Adjustments and I - [POST /api/Inventory/GetStatus](https://developer.wineshipping.com/api/v3.1/openapi/inventory/getinventorystatus.md): This operation provides inventory information with warehouse, status, quantity on hand, quantity reserved on orders, quantity on backorder, quantity available, and quantity on an inbound PO. This oper - [POST /api/Inventory/GetSellable](https://developer.wineshipping.com/api/v3.1/openapi/inventory/getsellable.md): This operation provides the total, aggregated inventory available to sell. This operation optionally accepts a list of warehouse codes to return sellable inventory totals for a specific subset of Wine ## Product - [POST /api/SKU/CreateSKU](https://developer.wineshipping.com/api/v3.1/openapi/product/createsku.md): Successful execution of this method will generate a new SKU in Wineshipping's system and will return a transaction reference identifier. Store this identifier back into your system for reference later - [POST /api/SKU/UpdateSKU](https://developer.wineshipping.com/api/v3.1/openapi/product/updatesku.md): Update an inventory item - [POST /api/SKU/RetireSku](https://developer.wineshipping.com/api/v3.1/openapi/product/retiresku.md): Successful execution of this method will deactivate a SKU in Wineshipping's system and will return a transaction reference identifier. ## Tracking - [POST /api/Tracking/GetDetails](https://developer.wineshipping.com/api/v3.1/openapi/tracking/getdetails.md): Order tracking details and status from shipping carriers when available. Use customer and order identifiers to locate associated records, including tracking numbers, order fulfillment and carrier stat - [POST /api/Tracking/GetPackages](https://developer.wineshipping.com/api/v3.1/openapi/tracking/getpackages.md): This operation provides package information in batches once warehouse activity started in order fulfillment. Provides filters options to search for packages by ship date range, last activity date rang ## Commerce - [POST /api/Address/Validation](https://developer.wineshipping.com/api/v3.1/openapi/commerce/addressvalidation.md): Use the Wineshipping Address Validation and Classification API operation to validate/correct and classify recipient addresses before you send the order to Wineshipping for fulfillment service. This AP - [POST /api/Address/GetCarrierLocations](https://developer.wineshipping.com/api/v3.1/openapi/commerce/getcarrierlocations.md): This operation returns carrier pickup locations where wine shipments are allowed. You can filter your search by carrier, city, state, ZIP code, and paginate through the result set. ***Note:** The info - [POST /api/Tracking/GetDeliveryEstimates](https://developer.wineshipping.com/api/v3.1/openapi/commerce/getdeliveryestimates.md): This operation provides delivery date estimation for Wineshipping fulfillment using FedEx and UPS carrier services within the USA. It requires an authenticated request with the recipient delivery addr