Ware2Go API Documentation: Production

1 Purpose

The purpose of this document is to describe the technical details of the W2G API interface, which enables merchants to manage their inventory and orders within the W2G platform. This document explains the technology used for communication and request and response message content and formats.

To become an integrator please reach out to support@ware2go.co to request access and discuss your business needs.

Last update to documentation: v 2.4.0

.

2 Request

2.1 Base URL

Ware2Go API is organized around REST. Ware2Go APIs use the standard HTTP Verbs like GET, POST, PUT and DELETE and return standard

HTTP Status Codes in the response.

.

2.2. Authentication

All W2G API calls are authenticated using an access token and a secret. These last indefinitely and do not need to be refreshed. You will obtain your access token and secret by contacting us at support@ware2go.co.

W2G API authentication follows the HTTP Basic Access Authentication standard. Your access token functions as the username and the secret as the password.

To illustrate, if your access token is 12345 and your secret is abcdef, your Authentication header would be Basic MTIzNDU6YWJjZGVm MTIzNDU6YWJjZGVm is the base64 encoding of 12345:abcdef

.

2.3 Pagination

The List objects will have pagination and the API leverages the page and link attributes.

  • page – current page of up to 100 objects
  • link – the link to the next page

.

2.4 API Versions

The W2G API framework uses a URL-based versioning system in which each version can be accessed by adding a prefix to the beginning of each resource’s URI string. At this time, there is only v1. In the future, W2G may create additional versions.

.

3 Response

We will respond with the appropriate HTTP status code and will provide response encoded in JSON and specify Content-Type “application/json”.

Status code Description
200 OK - acceptable request
201 Created - new resource created
400 Bad request - malformed, missing parameters, etc.
401 Unauthorized - incorrect security information
403 Forbidden - access disallowed
404 Not Found - unable to find resource
429 Too many requests - sent too many requests in a given amount of time
500 Internal server error - unknown error

.

4 API Overview

With the W2G API, you can perform functions related to items and orders:

  • For items, you can:
    • Create an item
    • Edit an item
    • Retrieve a full list of all items
    • Retrieve specific details for a single item
  • For outbound orders, you can:
    • Create an order (which uploads and submits the order)
    • Cancel and resubmit an order
    • Retrieve a full list of all orders
    • Retrieve specific details for a single order
    • Retrieve a list of warehouses to which you are matched
  • For inbound shipments, you can:
    • Create an inbound shipment
    • Cancel an inbound shipment
    • Retrieve a full list of inbound shipments
    • Retrieve specific details for a single inbound shipments
  • For Invoices, you can:
    • Get all invoices
    • Retrieve a specific invoice
    • Retrieve a specific date rate of invoices

 

.

5 API Resources

5.1 Inventory Endpoints

Retrieve a list of all items, specific details for a single item, add an item, and update an item.

Inventory items can be identified by:

  • SkuId (external ID assigned to each item by the user)

.

5.1.1 Retrieve all items

GET https://openapi.ware2go.co/ware2go/v1/merchants/4/inventory

SKU Summary Object

Field Name Type Comments
page integer
link string
skus array
/skuid string
/skuName string
/description string
/sfpEnabled boolean
/warehouseQuantity aray
/warehouseFacilityId int
/warehouseFacilityName string
/atp int
/qoh int

JSON response example

     {

            "page": 1,

            "link": "https://staging.ware2goproject.com/ware2go/v1?page=2",

            "skus": [

            {

                    "skuId": "AB-56786-case",

                    "skuName": "4x Logitech mice",

                    "description": "Black, 4.25 inches, qt. 4",

                    "sfpEnabled": true,

                    "warehouseQuantity": []

                },

                {

                    "skuId": "SKU-181",

                    "skuName": "Water bottle - black",

                    "description": "aaa",

                    "sfpEnabled": false,

                    "warehouseQuantity": []

                }

            ]

        }
code1

5.1.2 Retrieve Detailed Information for a Specific Item

GET https://openapi.ware2go.co/ware2go/v1/merchants/4/inventory/SKU-1234568

SKU Object

Field Name Type Comments Character Limits
skuId string 30
skuName string 100
description string 100
specialCharacteristics array of enums None
length float Provide in inches max value of 999999999999
width float Provide in inches max value of 999999999999
height float Provide in inches max value of 999999999999
weight float Provide in pounds max value of 999999999999
replacementCost double must be greater than 0 max value of 50000
restockLevel int must be greater than or equal to 0 max value of 999999999999
stackable boolean
maxStackHeight int must have 'stackable=true' and must be greater than 0 max value of 999999999999
outboundShippableFormat boolean
requiresFiller boolean
disposalInformation enum None, dispose, destroy and dispose
isCase boolean
componentSku string must be a valid SKU id 30
componentSkuQuantity int componentSku must be a valid SKU and must be greater than 0 max value of 999999999999
insuranceRequired boolean
sfpEnabled boolean
proofOfDelivery enum NO, YES
warehouseQuantity array
/warehousefacilityId int ??
warehousefacilityName string
/atp int available to pick at the specified warehouse read-only
int quantity on hand at the specified warehouse read-only

JSON response example

    {

            "skuId": "SKU-1234568",

            "skuName": "Water bottle - black",

            "description": null,

            "specialCharacteristics": [

                "NONE"

            ],

            "length": 20,

            "width": 10,

            "height": 48,

            "weight": 2,

            "replacementCost": 10,

            "restockLevel": 0,

            "stackable": true,

            "maxStackHeight": 20,

            "outboundShippableFormat": true,

            "requiresFiller": null,

            "disposalInformation": "null",

            "isCase": false,

            "componentSku": null,

            "componentSkuQuantity": null,

            "insuranceRequired": false,

            "sfpEnabled": true,

            "proofOfDelivery": "NO",

            "warehouseQuantity": []

        }

5.1.3 Create and edit an item

https://openapi.ware2go.co/ware2go/v1/merchants/171/inventory

SKU Object

Field Name Type Comments Required/Optional length
skuId string REQUIRED
skuName string REQUIRED
description string OPTIONAL
specialCharacteristics array of enums None REQUIRED
length float Provide in inches REQUIRED
width float Provide in inches REQUIRED
height float Provide in inches REQUIRED
weight float Provide in pounds REQUIRED
replacementCost double must be greater than 0 REQUIRED
restockLevel int must be greater than or equal to 0 OPTIONAL
stackable boolean OPTIONAL
maxStackHeight int must have 'stackable=true' and must be greater than 0 OPTIONAL
outboundShippableFormat boolean REQUIRED
requiresFiller boolean Required if outboundShippableFormat = false OPTIONAL
disposalInformation enum None, dispose, destroy and dispose REQUIRED
isCase boolean OPTIONAL
componentSku string must be a valid SKU id OPTIONAL
componentSkuQuantity int componentSku must be a valid SKU and must be greater than 0 OPTIONAL
insuranceRequired boolean OPTIONAL
sfpEnabled boolean SFP is Seller Fulfilled Prime REQUIRED
proofOfDelivery enum NO, YES, ADULT Note: Adult is not supported today OPTIONAL

A success response will include all the details for the item.

JSON response example

    {

            "skuId": "SKU-2353434344567",

            "skuName": "Water bottle - burgundy",

            "description": "aaaaaaaaaaaa",

            "specialCharacteristics": [

                "NONE"

            ],

            "length": 20,

            "width": 20,

            "height": 30,

            "weight": 2,

            "replacementCost": 10,

            "restockLevel": 10000,

            "stackable": false,

            "maxStackHeight": null,

            "outboundShippableFormat": true,

            "requiresFiller": null,

            "disposalInformation": "null",

            "isCase": true,

            "componentSku": "AB-56789",

            "componentSkuQuantity": 4,

            "sfpEnabled": false

        }

Success response

     {

            "skuId": "SKU-2353434344567",

            "skuName": "Water bottle - burgundy",

            "description": "aaaaaaaaaaaa",

            "specialCharacteristics": [

                "NONE"

            ],

            "length": 20,

            "width": 20,

            "height": 30,

            "weight": 2,

            "replacementCost": 10,

            "restockLevel": 10000,

            "stackable": false,

            "maxStackHeight": null,

            "outboundShippableFormat": true,

            "requiresFiller": null,

            "disposalInformation": "null",

            "isCase": true,

            "componentSku": "AB-56789",

            "componentSkuQuantity": 4,

            "sfpEnabled": false,

            "proofOfDelivery": null,

            "warehouseQuantity": null

        }

5.1.4 Delete an item

.

5.2 Order Endpoints

Creating an order item requires a ReferenceId. ReferenceId is the external ID assigned to the order by the user.

Once an order is submitted with a referenceID, the W2G system creates an order with an Order ID and returns the Order ID to the user in the response. Further calls (retrieving specific details about an order or canceling an order) require the use of OrderId to identify the order.

.

5.2.1 Retrieve all orders

GET https://openapi.ware2go.co/ware2go/v1/merchants/4/orders/

Order Summary Object

Field Name Type Comments
page int
link string
orders array
/referenceNumber string reference number is the id provided by the user
/purchaseOrderNumber string purchase order number is the id provided by the user
/outOfRegion boolean
/companyName string
/shippingSpeed enum TWO_DAY, ECONOMY, NEXT_DAY, SFP, FREIGHT
/status enum Draft, Processing, In Picking, Picked, Ready for UPS, Ready for Carrier, In Transit, Delivered, Exception, Cancelled, Delivered
/inventoryAvailable boolean
/warehouseFacility array
/id int
/name string
/orderId string order id is the W2G order number

JSON response example

   {

            "page": 1,

            "link": "https://staging.ware2goproject.com/ware2go/v1/merchants/2498/orders?page=2",

            "orders": [{

                    "referenceId": "112-5434996-3937875",

                    "purchaseOrderNumber": "PO00011",

                    "outOfRegion": true,

                    "companyName": "Customer Company",

                    "shippingSpeed": "TWO_DAY",

                    "status": "APPROVED",

                    "inventoryAvailable": true,

                    "orderId": "29017",

                    "warehouseFacility": {

                        "id": 11,

                        "name": "Fort Worth 394"

                    }

                },

                {

                    "referenceId": "112-5434996-3937874",

                    "purchaseOrderNumber": "PO000010",

                    "outOfRegion": true,

                    "companyName": "Customer Company",

                    "shippingSpeed": "TWO_DAY",

                    "status": "APPROVED",

                    "inventoryAvailable": true,

                    "orderId": "29016",

                    "warehouseFacility": {

                        "id": 11,

                        "name": "Fort Worth 394"

                    }

                }

            ]

        }

5.2.2 Retrieve details for a specific order

GET https://openapi.ware2go.co/ware2go/v1/merchants/4/orders/11881

Order Object

Field Name Type Comments Character Limits
orderId int 20
orderDate date-time format 20
referenceId string 30
purchaseordernumber string 30
outOfRegion boolean
skuQuantities array
/skuId string 30
/skuName string 100
/unitQuantity int max value of 999999999
enum NO, YES
/insuranceRequired boolean
companyName string 30
address1 string 35
string 30
zipcode int 5 or 9
country string must be USA 3
status enum Draft, Processing, In Picking, Picked, Ready for UPS, Ready for Carrier, In Transit, Delivered, Exception, Cancelled, Delivered
packages array
/id string 5
/trackingNumber string 60
/status enum SHIPPED, IN_TRANSIT, DELIVERED, EXCEPTION, LATE
/carrierName string 255
/proofOfDelivery enum NO, YES
/height float max value of 999999999999
/width float max value of 999999999999
/length float max value of 999999999999
/weight float max value of 999999999999
/contents array
/sku string 30
/quantity integer max value of 999999999999
inventoryAvailable boolean
warehouseFacility array
/id int ??
/name string 100
phoneNumber string 15
buyerEmail string 255
city string 30
state enum must be two letters, such as in GA or TX 2
shippingSpeed enum TWO_DAY, ECONOMY, NEXT_DAY, SFP, FREIGHT

JSON response example

 {

            "orderId": "44723",

            "orderDate": null,

            "referenceId": "986734-MVKP13",

            "purchaseOrderNumber": "982342-MVKP",

            "outOfRegion": false,

            "skuQuantities": [{

                    "skuId": "Tesla Model 10",

                    "skuName": "Example SKU 21",

                    "unitQuantity": 1,

                    "proofOfDelivery": "YES",

                    "insuranceRequired": true

                },

                {

                    "skuId": "Tesla Model 11",

                    "skuName": "Example SKU 22",

                    "unitQuantity": 1,

                    "proofOfDelivery": "YES",

                    "insuranceRequired": true

                },

                {

                    "skuId": "Tesla Model 13",

                    "skuName": "Example SKU 24",

                    "unitQuantity": 1,

                    "proofOfDelivery": "NO",

                    "insuranceRequired": false

                }

            ],

            "companyName": "Customer Company",

            "address1": "1234 Headquarters Drive",

            "address2": "Suite 500",

            GET https: //openapi.ware2go.co/ware2go/v1/merchants/4/orders/11881

                "zipCode": "90000",

            "country": "USA",

            "status": "SHIPPED",

            "packages": [{

                    "id": "00001",

                    "trackingNumber": "1Z49040R4214608145",

                    "status": "SHIPPED",

                    "carrierName": "UPS",

                    "proofOfDelivery": "YES",

                    "height": 4.0,

                    "width": 8.0,

                    "length": 8.0,

                    "weight": 12.0,

                    "contents": [{

                            "sku": "Tesla Model 10",

                            "quantity": 1

                        },

                        {

                            "sku": "Tesla Model 11",

                            "quantity": 1

                        }

                    ]

                },

                {

                    "id": "00002",

                    "trackingNumber": "1Z49040R0307586756",

                    "status": "SHIPPED",

                    "carrierName": "UPS",

                    "proofOfDelivery": "NO",

                    "height": 9.0,

                    "width": 9.0,

                    "length": 9.0,

                    "weight": 12.0,

                    "contents": [{

                        "sku": "Tesla Model 13",

                        "quantity": 1

                    }]

                }

            ],

            "inventoryAvailable": true,

            "insuredValue": 0,

            "warehouseFacility": {

                "id": 10,

                "name": "test warehouse 10"

            },

            "phoneNumber": "555-555-5555",

            "buyerEmail": "customer@company.com",

            "city": "Companysville",

            "state": "CA",

            "shippingSpeed": "TWO_DAY"

        }

5.2.3 Create a single order

POST https://openapi.ware2go.co/ware2go/v1/merchants/171/orders/

Order Object

Field Name Type Comments Required/Optional Length
referenceId string REQUIRED
skuQuantites array REQUIRED
/skuId string REQUIRED
/skuName string REQUIRED
/unitQuantity int REQUIRED
/proofOfDelivery enum YES, NO
/insuranceRequired boolean OPTIONAL
companyName string REQUIRED
address1 string REQUIRED
address2 string OPTIONAL
zipcode int Limit 5 characters REQUIRED
country string REQUIRED
status enum Draft, Processing, In Picking, Picked, Ready for UPS, Ready for Carrier, In Transit, Delivered, Exception, Cancelled, Delivered (NOT APPLICABLE FOR CREATING ORDERS)
packages array (NOT APPLICABLE FOR CREATING ORDERS)
/id string
/trackingNumber string
/status enum SHIPPED, IN_TRANSIT, DELIVERED, EXCEPTION, LATE
/carrierName string
/proofOfDelivery enum NO, YES
inventoryAvailable boolean OPTIONAL
warehouseFacility array NOTE: If you do not provide a warehouse for the outbound order, the platform will select a warehouse facility in the following manner:
  1. Does the merchant have a Ware2Go matched warehouse that is In Region of the destination address?
  2. Does the merchant have a Ware2Go matched warehouse that is Out Of Region of the destination address, but is within the UPS 2 day shipping footprint?
  3. Does the merchant have a Ware2Go matched warehouse that is OutOfRegion?
The platform does not check for inventory quantities at a warehouse
OPTIONAL
/id int NOTE: If you are identifying the warehouse to which you are sending an order, then you must supply the id for the warehouse facility REQUIRED
/name string OPTIONAL
phoneNumber string OPTIONAL
buyerEmail string OPTIONAL
city string REQUIRED
state enum must be two letters, as in GA or TX REQUIRED
shippingSpeed enum TWO_DAY, ECONOMY, NEXT_DAY, SFP, FREIGHT NOTE:
  1. If shipping speed is left blank, TWO_DAY will be selected.
  2. If shipping speed is TWO_DAY or blank, and the destination address is IN REGIOM, the order will be be created but not submitted. The user will need to change the shipping speed and submit the order
  3. For Amazon Prime orders, SFP must be selected as shipping speed (Also, the item must be identified as sfpEnabled and the merchant must be setup for SFP shipping in the Ware2Go Platform.
  4. For LTL or FTL shipping, FREIGHT must be supplied as the shipping speed.
OPTIONAL

Response

The success response will include the orderId for the order.

Request

 {

            "referenceId": "TX-1234599",

            "skuQuantities": [{

                "skuId": "SKU-04",

                "skuName": "Water bottle - black",

                "unitQuantity": 1,

                "proofOfDelivery": "NO",

                "insuranceRequired": false

            }],

            "companyName": "warehouse south central",

            "address1": "234 W 42 St.",

            "address2": null,

            "zipCode": "10036",

            "country": "USA",

            "warehouseFacility": {

                "id": 9,

                "name": "Mount Joy 991"

            },

            "phoneNumber": "3235554561",

            "buyerEmail": "nitish@gmail.com",

            "city": "New York",

            "state": "NY",

            "shippingSpeed": "TWO_DAY"

        }

Order Response

   {

            "orderId": "12121",

            "referenceId": "TX-1234599",

            "outOfRegion": false,

            "skuQuantities": [{

                "skuId": "SKU-04",

                "skuName": "Water bottle - black",

                "unitQuantity": 1,

                "proofOfDelivery": "NO",

                "insuranceRequired": false

            }],

            "companyName": "warehouse south central",

            "address1": "234 W 42 St.",

            "address2": null,

            "zipCode": "10036",

            "country": "USA",

            "status": "APPROVED",

            "packages": [],

            "inventoryAvailable": true,

            "warehouseFacility": {

                "id": 9,

                "name": "Mount Joy 991"

            },

            "phoneNumber": "3235554561",

            "buyerEmail": "nitish@gmail.com",

            "city": "New York",

            "state": "NY",

            "shippingSpeed": "TWO_DAY"

        }

5.2.4 Cancel and resubmit a single order

Request

  •  The request to cancel an order should have the merchant id, the order id, and resubmit as part of the endpoint request. The body should contain the order details as in posting a new order.
 
Response
 
  • A success response will contain the order details.

.

5.2.5 Warehouse

As part of an order, a merchant must specify the warehouse for which they want to fulfill the order. The Warehouse endpoint enables the user to retrieve the warehouse(s) (and the associated id) assigned to the merchant. The user can passes the warehouse id as part of their order.

https://openapi.ware2go.co/ware2go/v1/merchants/4/match

Warehouse Match Object

Field Name Type Comments
Matches array
/id int
/name string

JSON Response

{

            "matches": [{

                    "id": 9,

                    "name": "Mount Joy"

                },

                {

                    "id": 11,

                    "name": "Fort Worth"

                }

            ]

        }

5.3 Inbound Shipping Endpoints

An Inbound Shipment enables a merchant to notify the warehouse of the shipment being sent by the merchant to the warehouse.

5.3.1 Retrieve all Inbound Shipments for a merchant

 

Retrieve Inbound Shipments

https://openapi.ware2go.co/ware2go/v1/merchants/171/inbound_shipments

Inbound Shipment Object Summary

Field Name Type Comments
page int
link string
shipments array
/shipmentId int
/referenceId int
/carrier string
/estimatedDeliveryDate date
/status string
/destinationFacility array
/id int
/name string

JSON Response

{

            "page": 1,

            "link": "https://staging.ware2goproject.com/ware2go/v1/merchants/171/inbound_shipments?

            page = 2 ",

            "shipments": [{

                "shipmentId": 13208,

                "referenceId": null,

                "carrier": null,

                "estimatedDeliveryDate": "2019-01-21T18:00:00Z",

                "status": "SHIPPED",

                "destinationFacility": {

                    "id": 9,

                    "name": "Mount Joy 991"

                }

            }]

        }

5.3.2 Retrieve details for a specific Inbound Shipment

https://openapi.ware2go.co/ware2go/v1/merchants/171/inbound_shipments/12841

Inbound Shipment Object

Field Name Type Comments Character Limits
shipmentId int 20
referenceId string 20
shipmentName string 255
carrier string 255
estimatedDeliveryDate date 20
estimatedShipDate date 20
companyName string 100
address1 string 255
address2 string 255
address3 string 100
country string must be USA 3
status enum
trackingNumber string 60
items array
/skuId string 30
/name string 100
/quantity int max value of 999999999
/quantityAccepted int max value of 999999999
/quantityRejected int
/rejectionIds SRJ_NOT_ORDERED, SRJ_DAMAGED, SRJ_SHORT, SRJ_OTHER, SRJ_OVER_SHIPPED
/unitsPerPackage int max value of 999999999
pallets array
/height int max value of 999999999
/weight int max value of 999999999
/mixedQuantity int max value of 999999999
/mixedQuantityReceived int max value of 999999999
/quantity int max value of 999999999
/quantityReceived int max value of 999999999
destinationFacility array
/id int
/name string 100
city string 30
zipcode string Limit 5 or 9 characters 5 or 9
state string 2

JSON Response

{

            "shipmentId": 12841,

            "referenceId": null,

            "shipmentName": null,

            "carrier": null,

            "estimatedDeliveryDate": "2018-12-29T20:00:00Z",

            "estimatedShipDate": null,

            "companyName": null,

            "address1": null,

            "address2": null,

            "address3": null,

            "country": null,

            "status": "RECEIVED",

            "trackingNumber": null,

            "items": [{

                "skuId": "SKU-1234568",

                "name": "Water bottle - black",

                "quantity": 200,

                "quantityAccepted": 200,

                "quantityRejected": 0,

                "rejectionIds": null,

                "unitsPerPackage": 1

            }],

            "pallets": null,

            "destinationFacility": {

                "id": 9,

                "name": "Mount Joy 991"

            },

            "city": null,

            "zipcode": null,

            "state": null

        }

5.3.3 Create an Inbound Shipment

 

Create an Inbound Shipment Request

https://openapi.ware2go.co/ware2go/v1/merchants/171/inbound_shipments/

Inbound Shipment Object

Field Name Type Comments Required/Optional Length
referenceId string OPTIONAL
shipmentName string OPTIONAL (Recommended so that you can identify different shipments)
carrier string OPTIONAL
estimatedDeliveryDate date REQUIRED
estimatedShipDate date OPTIONAL
companyName string OPTIONAL (NOTE: Data field is not visible on the web platform)
address1 string OPTIONAL (NOTE: Data field is not visible on the web platform)
address2 string OPTIONAL (NOTE: Data field is not visible on the web platform)
address3 string OPTIONAL (NOTE: Data field is not visible on the web platform)
country string OPTIONAL (NOTE: Data field is not visible on the web platform)
trackingNumber string OPTIONAL
items array
/skuId string REQUIRED
/name string OPTIONAL
/quantity int REQUIRED
/unitsPerPackage int REQUIRED
pallets array OPTIONAL, only if shipping by pallets
/height int REQUIRED
/weight int REQUIRED
/mixedQuantity int REQUIRED
/quantity int REQUIRED
destinationFacility array REQUIRED
/id int REQUIRED
/name string OPTIONAL
city string OPTIONAL (NOTE: Data field is not visible on the web platform)
zipcode string Limit 5 characters OPTIONAL (NOTE: Data field is not visible on the web platform)
state string OPTIONAL (NOTE: Data field is not visible on the web platform)

Response

  • Response includes all the fields sent in the request, plus
    • shipmentId
    • status
    • items:
      • quantityAccepted
      • quantityRejected
      • rejectionIds

JSON Response

{

            "referenceId": null,

            "shipmentName": "Test-20190123A",

            "carrier": null,

            "estimatedDeliveryDate": "2019-01-22T18:00:00Z",

            "estimatedShipDate": null,

            "companyName": null,

            "address1": null,

            "address2": null,

            "address3": null,

            "country": null,

            "trackingNumber": null,

            "items": [{

                    "skuId": "IOS-1235",

                    "name": "iPad case- blue",

                    "quantity": 20,

                    "unitsPerPackage": 4

                },

                {

                    "skuId": "IOS-1236",

                    "name": "iPad case- black",

                    "quantity": 5,

                    "unitsPerPackage": 1

                }

            ],

            "destinationFacility": {

                "id": 9,

                "name": "Mount Joy 991"

            },

            "city": null,

            "zipcode": null,

            "state": null

        }

Create ASN Response

    {

            "shipmentId": 13302,

            "referenceId": null,

            "shipmentName": "Test-20190123A",

            "carrier": null,

            "estimatedDeliveryDate": "2019-01-22T18:00:00Z",

            "estimatedShipDate": null,

            "companyName": null,

            "address1": null,

            "address2": null,

            "address3": null,

            "country": null,

            "status": "SHIPPED",

            "trackingNumber": null,

            "items": [{

                    "skuId": "IOS-1235",

                    "name": null,

                    "quantity": 20,

                    "quantityAccepted": 0,

                    "quantityRejected": 0,

                    "rejectionIds": null,

                    "unitsPerPackage": 4

                },

                {

                    "skuId": "IOS-1236",

                    "name": null,

                    "quantity": 5,

                    "quantityAccepted": 0,

                    "quantityRejected": 0,

                    "rejectionIds": null,

                    "unitsPerPackage": 1

                }

            ],

            "pallets": null,

            "destinationFacility": {

                "id": 9,

                "name": "Mount Joy 991"

            },

            "city": null,

            "zipcode": null,

            "state": null

        }

5.3.4 Cancel an Inbound Shipment

  • POST
    • https://openapi.ware2go.co/ware2go/v1/merchants/{merchantId}/inbound_shipments/{shipmentId}/cancel
    • Requires the specific shipment ID
    • Cancels an Inbound Shipment that was previously ‘Processing
    • Response includes the entire Inbound Shipment and the status changes to “CANCELLED”

Response

  {

            "shipmentId": 13304,

            "referenceId": null,

            "shipmentName": "Test-20190123B",

            "carrier": null,

            "estimatedDeliveryDate": "2019-01-22T18:00:00Z",

            "estimatedShipDate": null,

            "companyName": null,

            "address1": null,

            "address2": null,

            "address3": null,

            "country": null,

            "status": "CANCELLED",

            "trackingNumber": null,

            "items": [{

                    "skuId": "IOS-1235",

                    "name": null,

                    "quantity": 20,

                    "quantityAccepted": 0,

                    "quantityRejected": 0,

                    "rejectionIds": null,

                    "unitsPerPackage": 4

                },

                {

                    "skuId": "IOS-1236",

                    "name": null,

                    "quantity": 5,

                    "quantityAccepted": 0,

                    "quantityRejected": 0,

                    "rejectionIds": null,

                    "unitsPerPackage": 1

                }

            ],

            "pallets": null,

            "destinationFacility": {

                "id": 9,

                "name": "Mount Joy 991"

            },

            "city": null,

            "zipcode": null,

            "state": null

        }

5.4 Get Invoices

Enables a merchant to retrieve their invoices.

5.4.1 Get All Invoices

Response

 {

            "page": null,

            "link": null,

            "results": [{

                        "startDate": "2019-02-01",

                        "endDate": "2019-02-14",

                        "dueDate": "2019-03-21",

                        "totalAmount": {

                            "amount": 0,

                            "currency": "USD"

                        },

                        "status": "NA",

                        "id": 495078,

                        "invoiceItems": [],

                        "payments": null,

                        "merchant": {

                            "id": 2498

                        }

                    },

                    {

                        "startDate": "2019-04-15",

                        "endDate": "2019-04-30",

                        "dueDate": "2019-06-04",

                        "totalAmount": {

                            "amount": 21.28,

                            "currency": "USD"

                        },

                        "status": "OVERDUE",

                        "id": 496343,

                        "invoiceItems": [{

                                    "id": 14583,

                                    "merchantId": 2498,

                                    "warehouseId": 11,

                                    "itemDate": "2019-04-29",

                                    "description": "Receipt of inbound shipment - small package shipment

                                    #17302",

"quantity": 20,

"itemPrice": {

"amount": 1,

"currency": "USD"

},

"totalPrice": {

"amount": 20,

"currency": "USD"

}

},

{

"id": 14594,

"merchantId": 2498,

"warehouseId": 10,

"itemDate": "2019-04-30",

"description": "Storage fee - Foothill Ranch 500",

"quantity": 0.067,

"itemPrice": {

"amount": 9.6,

"currency": "USD"

},

"totalPrice": {

"amount": 0.64,

"currency": "USD"

}

}

5.4.2 Get Single Invoice

JSON Response

   {

            "startDate": "2019-04-15",

            "endDate": "2019-04-30",

            "dueDate": "2019-06-04",

            "totalAmount": {

                "amount": 21.28,

                "currency": "USD"

            },

            "status": "OVERDUE",

            "id": 496343,

            "invoiceItems": [{

                        "id": 14583,

                        "merchantId": 2498,

                        "warehouseId": 11,

                        "itemDate": "2019-04-29",

                        "description": "Receipt of inbound shipment - small package shipment #17302",

"quantity": 20,

"itemPrice": {

"amount": 1,

"currency": "USD"

},

"totalPrice": {

"amount": 20,

"currency": "USD"

}

},

{

"id": 14594,

"merchantId": 2498,

"warehouseId": 10,

"itemDate": "2019-04-30",

"description": "Storage fee - Foothill Ranch 500",

"quantity": 0.067,

"itemPrice": {

"amount": 9.6,

"currency": "USD"

},

"totalPrice": {

"amount": 0.64,

"currency": "USD"

}

},

{

"id": 14596,

"merchantId": 2498,

"warehouseId": 11,

"itemDate": "2019-04-30",

"description": "Storage fee - Fort Worth 394",

"quantity": 0.067,

"itemPrice": {

"amount": 9.6,

"currency": "USD"

},

"totalPrice": {

"amount": 0.64,

"currency": "USD"

}

}

],

"payments": [],

"merchant": {

"id": 2498

}

}

Response

  {

            "page": null,

            "link": null,

            "results": [{

                "startDate": "2019-07-01",

                "endDate": "2019-07-14",

                "dueDate": "2019-08-18",

                "totalAmount": {

                    "amount": 36.23,

                    "currency": "USD"

                },

                "status": "CURRENT",

                "id": 498636,

                "invoiceItems": [{

                        "id": 19280,

                        "merchantId": 2498,

                        "warehouseId": 9,

                        "itemDate": "2019-07-09",

                        "description": "Storage fee - Mount Joy 991",

                        "quantity": 0.29,

                        "itemPrice": {

                            "amount": 9.6,

                            "currency": "USD"

                        },

                        "totalPrice": {

                            "amount": 2.79,

                            "currency": "USD"

                        }

                    },

                    {

                        "id": 19402,

                        "merchantId": 2498,

                        "warehouseId": 11,

                        "itemDate": "2019-07-09",

                        "description": "Storage fee - Fort Worth 394",

                        "quantity": 1.161,

                        "itemPrice": {

                            "amount": 9.6,

                            "currency": "USD"

                        },

                        "totalPrice": {

                            "amount": 11.15,

                            "currency": "USD"

                        }

                    },

                    {

                        "id": 19466,

                        "merchantId": 2498,

                        "warehouseId": 168,

                        "itemDate": "2019-07-09",

                        "description": "Storage fee - Los Angeles 131",

                        "quantity": 2.323,

                        "itemPrice": {

                            "amount": 9.6,

                            "currency": "USD"

                        },

                        "totalPrice": {

                            "amount": 22.3,

                            "currency": "USD"

                        }

                    }

                ],

                "payments": null,

                "merchant": {

                    "id": 2498

                }

            }]

        }