Skip to content
/Product

REST API (3.1.3)

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.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://wineshipping.com
API Support
api@wineshipping.com
License
Proprietary
Languages
Servers
Test
https://api-test.wineshipping.com/v3
Production
https://api.wineshipping.com/v3

Fulfillment

API Methods for order processing and fulfillment.

Operations

Inventory

API Methods for inventory management.

Operations

Product

API Methods for item management.

Operations

Create item

Request

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 in the event there is an issue with the SKU.

Security
Authentication
Bodyapplication/json
Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.​UserKeystringrequired
Example: "C445598CB576468EA35FBB22C55584EF"
Authentication.​Passwordstringrequired
Example: "AF63FDAC1E704DC1AC9460F669ABF107"
Authentication.​CustomerNostringrequired
Example: "10703"
RequestorInfoobject(RequestorInfo)required

Information about the person making the request

RequestorInfo.​FirstNamestring[ 1 .. 60 ] charactersrequired

First name of the requester

Example: "John"
RequestorInfo.​LastNamestring[ 1 .. 60 ] charactersrequired

Last name of the requester

Example: "Doe"
RequestorInfo.​EmailAddressstring(email)<= 255 characters^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...required

Valid email address of the requester

Example: "john.doe@wineshipping.com"
RequestorInfo.​PhoneNumberstring[ 10 .. 255 ] characters

Contact phone number of the requester

Example: "555-555-5555"
SKUInfoobject(SKUInfo)required
SKUInfo.​ItemCategorystringrequired
Enum"Wine""MarketingMaterial""Merchandise""TastingFee""IcePack"
SKUInfo.​InventoryManagementTypeany

Inventory Management Type determines how an item's inventory will be managed.
WineshippingManagedStorage - Inventory is managed in WS Warehouses.
ClientManagedStorage - Inventory is managed by the client in their own warehouses.
VirtualItems - Are items required for Point of Sale or fulfillmet such as tasting fees and icepacks.

If an item will be fulfilled by both WS and the Client, please select WineshippingManagedStorage (default value).

Default "WineshippingManagedStorage"
Enum"WineshippingManagedStorage""ClientManagedStorage""Virtual"
SKUInfo.​ItemNostring<= 30 charactersrequired
Example: "SKU8866EWINE"
SKUInfo.​ItemDescriptionstring<= 250 charactersrequired
SKUInfo.​Vintagestring
Example: "2022 CHARDONNAY ESTATE 12/750"
SKUInfo.​Varietalstringrequired

Required if item category is Wine.

See varietal codes for possible values.

Example: "CHARD"
SKUInfo.​Appellationstring<= 250 characters
Example: "ESTATE 12/750"
SKUInfo.​Valuestringrequired

The dollar value of the item.

Example: "50.99"
SKUInfo.​AlcoholByVolumestring
SKUInfo.​UPCCodestring
SKUInfo.​UOMstringrequired

See units of measure for possible values

SKUInfo.​NumBottleInEachCasestring

Number of items in each wholesale case

SKUInfo.​NumCasesInEachPalletstring

(COMING SOON) Number of cases per pallet

SKUInfo.​Classificationstring

Wine: 'Still' or 'Sparkling'

SKUInfo.​Commentsstring
curl -i -X POST \
  https://api-test.wineshipping.com/v3/api/SKU/CreateSKU \
  -H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Authentication": {
      "UserKey": "C445598CB576468EA35FBB22C55584EF",
      "Password": "AF63FDAC1E704DC1AC9460F669ABF107",
      "CustomerNo": "10703"
    },
    "RequestorInfo": {
      "FirstName": "John",
      "LastName": "Smith",
      "PhoneNumber": "7079339063",
      "EmailAddress": "johnsmith@wineshipping.com"
    },
    "SKUInfo": {
      "ItemCategory": "Wine",
      "ItemNo": "SKU8866EWINE",
      "ItemDescription": "2016 CHARDONNAY ESTATE 12/750",
      "Vintage": "2016",
      "Varietal": "CHARD",
      "Appellation": "ESTATE 12/750",
      "Value": "120.00",
      "AlcoholByVolume": "12.5",
      "UPCCode": "573421378534",
      "UOM": "750",
      "NumBottleInEachCase": "12",
      "Classification": "Still",
      "Comments": "Test SKU!"
    }
  }'

Responses

Returns a transaction reference identifier of the created SKU.

Update item

Request

Update an inventory item

Security
Authentication
Bodyapplication/json
Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.​UserKeystringrequired
Example: "C445598CB576468EA35FBB22C55584EF"
Authentication.​Passwordstringrequired
Example: "AF63FDAC1E704DC1AC9460F669ABF107"
Authentication.​CustomerNostringrequired
Example: "10703"
RequestorInfoobject(RequestorInfo)required

Information about the person making the request

RequestorInfo.​FirstNamestring[ 1 .. 60 ] charactersrequired

First name of the requester

Example: "John"
RequestorInfo.​LastNamestring[ 1 .. 60 ] charactersrequired

Last name of the requester

Example: "Doe"
RequestorInfo.​EmailAddressstring(email)<= 255 characters^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...required

Valid email address of the requester

Example: "john.doe@wineshipping.com"
RequestorInfo.​PhoneNumberstring[ 10 .. 255 ] characters

Contact phone number of the requester

Example: "555-555-5555"
SKUInfoobjectrequired
SKUInfo.​ItemNostring<= 30 charactersrequired

Used as key to update the correct item

SKUInfo.​ItemDescriptionstring<= 255 characters
SKUInfo.​Valuestring
curl -i -X POST \
  https://api-test.wineshipping.com/v3/api/SKU/UpdateSKU \
  -H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Authentication": {
      "UserKey": "C445598CB576468EA35FBB22C55584EF",
      "Password": "AF63FDAC1E704DC1AC9460F669ABF107",
      "CustomerNo": "10703"
    },
    "RequestorInfo": {
      "FirstName": "John",
      "LastName": "Smith",
      "PhoneNumber": "7079339063",
      "EmailAddress": "johnsmith@wineshipping.com"
    },
    "SKUInfo": {
      "ItemNo": "SKU8866EWINE",
      "ItemDescription": "2016 CHARDONNAY ESTATE 12/750",
      "Value": "120.00"
    }
  }'

Responses

OK

Retire item

Request

Successful execution of this method will deactivate a SKU in Wineshipping's system and will return a transaction reference identifier.

Security
Authentication
Bodyapplication/json
Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.​UserKeystringrequired
Example: "C445598CB576468EA35FBB22C55584EF"
Authentication.​Passwordstringrequired
Example: "AF63FDAC1E704DC1AC9460F669ABF107"
Authentication.​CustomerNostringrequired
Example: "10703"
ItemNostringrequired
curl -i -X POST \
  https://api-test.wineshipping.com/v3/api/SKU/RetireSku \
  -H 'Authorization: WineshippingAuth <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Authentication": {
      "UserKey": "C445598CB576468EA35FBB22C55584EF",
      "Password": "AF63FDAC1E704DC1AC9460F669ABF107",
      "CustomerNo": "10703"
    },
    "ItemNo": "string"
  }'

Responses

Returns a transaction reference identifier of the created SKU.

Tracking

API Methods for tracking and shipments.

Operations

Commerce

API Methods for carriers, expected delivery dates and addresses.

Operations