API Reference

Create item

Wineshipping API (3.1.2)

The Wineshipping 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

Servers

Mock server

https://developer.wineshipping.com/_mock/api/v3.1/openapi/

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.

Bodyapplication/json

Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.UserKeystringrequired

Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"

Authentication.Passwordstringrequired

Example: "A781281230444BD7BC72F7753B944A71"

Authentication.CustomerNostringrequired

Example: "10703"

RequestorInfoobject(RequestorInfo)required

Information about the person making the request

RequestorInfo.FirstNamestring[ 1 .. 100 ] charactersrequired

First name of the requestor

Example: "John"

RequestorInfo.LastNamestring[ 1 .. 100 ] charactersrequired

Last name of the requestor

Example: "Doe"

RequestorInfo.EmailAddressstring(email)^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...required

Valid email address of the requestor

Example: "john.doe@wineshipping.com"

RequestorInfo.PhoneNumberstring[ 10 .. 20 ] characters

Contact phone number of the requestor

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.ItemNostringrequired

SKUInfo.ItemDescriptionstring<= 250 charactersrequired

SKUInfo.Vintagestring

2022

SKUInfo.Varietalstring

Required if item category is Wine

See Codes & Descriptions for possbile values

SKUInfo.Appellationstring<= 250 characters

SKUInfo.Valuestring

SKUInfo.AlcoholByVolumestring

SKUInfo.UPCCodestring

SKUInfo.UOMstring

See Codes & Descriptions for possbile 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://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SKU/CreateSKU \
  -H 'Content-Type: application/json' \
  -d '{
    "Authentication": {
      "UserKey": "7304B15BB8C24567B765FF01A9F64DD4",
      "Password": "82F0E23F4F3B4A3D8CDA5245066703FA",
      "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

Bodyapplication/json

Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.UserKeystringrequired

Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"

Authentication.Passwordstringrequired

Example: "A781281230444BD7BC72F7753B944A71"

Authentication.CustomerNostringrequired

Example: "10703"

RequestorInfoobject(RequestorInfo)required

Information about the person making the request

RequestorInfo.FirstNamestring[ 1 .. 100 ] charactersrequired

First name of the requestor

Example: "John"

RequestorInfo.LastNamestring[ 1 .. 100 ] charactersrequired

Last name of the requestor

Example: "Doe"

RequestorInfo.EmailAddressstring(email)^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2...required

Valid email address of the requestor

Example: "john.doe@wineshipping.com"

RequestorInfo.PhoneNumberstring[ 10 .. 20 ] characters

Contact phone number of the requestor

Example: "555-555-5555"

SKUInfoobjectrequired

SKUInfo.ItemNostringrequired

Used as key to update the correct item

SKUInfo.ItemDescriptionstring

SKUInfo.Valuestring

curl -i -X POST \
  https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SKU/UpdateSKU \
  -H 'Content-Type: application/json' \
  -d '{
    "Authentication": {
      "UserKey": "7304B15BB8C24567B765FF01A9F64DD4",
      "Password": "82F0E23F4F3B4A3D8CDA5245066703FA",
      "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

Retire item

Request

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

Bodyapplication/json

Authenticationobject(Authentication)required

Credentials are required for all API operations.

Authentication.UserKeystringrequired

Example: "C5EAAD3DF1094EDFB2B4685F8A7AB2E1"

Authentication.Passwordstringrequired

Example: "A781281230444BD7BC72F7753B944A71"

Authentication.CustomerNostringrequired

Example: "10703"

ItemNostringrequired

curl -i -X POST \
  https://developer.wineshipping.com/_mock/api/v3.1/openapi/api/SKU/RetireSku \
  -H 'Content-Type: application/json' \
  -d '{
    "Authentication": {
      "UserKey": "C5EAAD3DF1094EDFB2B4685F8A7AB2E1",
      "Password": "A781281230444BD7BC72F7753B944A71",
      "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

Wineshipping API (3.1.2)

Fulfillment

Inventory

Product

Create item

Request

Responses

Was this helpful?

Update item

Request

Responses

Was this helpful?

Retire item

Request

Responses

Was this helpful?

Tracking

Commerce

Wineshipping API (3.1.2)

Fulfillment

Inventory

Product

Create item

RequestExpand all

Responses

Was this helpful?

Update item

RequestExpand all

Responses

Was this helpful?

Retire item

RequestExpand all

Responses

Was this helpful?

Tracking

Commerce

Request

Request

Request