1. Inventory Advice
    
2. Shipment Retrieval
    
3. Shipment Acknowledgement
    
4. Shipment Completion and Tracking
    
5. ASN Retrieval (optional)
6. ASN Acknowledgement (optional)
7. External Lot Creation (optional but highly encouraged)

• External SKU
• Shipment
• System of Record
• ASN
• External lot

See our Developer Portal for more information on using the RetailOps API.

For external SKUs and their inventory, RetailOps is not the system of record. The vendor manages this inventory so the vendor's system is the system of record. Because of this, RetailOps must receive regular updates from the vendor regarding the inventory levels. These updates are called inventory advice. In RetailOps, inventory advice is tracked against a vendor and a vendor product code (VPC).

To set inventory advice for a given VPC, use API call Product.ExternalSku.Update - Version 2. See a sample below.

curl -X POST 'https://api.gudtech.com/product/externalsku/update~2.json' \
    -H 'Content-Type: application/json' \
    -H 'apikey: YOUR_APIKEY_GOES_HERE' \
    -d '{ "records": [{ "vendor_id":"27","vpc":"ABC123","quantity":12 }] }'

In RetailOps, customer orders are subdivided into shipments, each of which must be fulfilled by one of your distribution centers, by one of your Dropship vendors, or by one of your 3PL vendors. For 3PL vendors, the vendor must retrieve shipments in a status of "Ready" and ship them to the customer.

To retrieve "Ready" shipments, use API call Fulfillment.Shipment.fetch - Version 1. See a sample below.

curl -X POST 'https://api.gudtech.com/fulfillment/shipment/fetch~1.json' \
    -H 'Content-Type: application/json' \
    -H 'apikey: YOUR_APIKEY_GOES_HERE' \
    -d '{ 
          "vendor_id":20, "status":"ready",
          "with_ship_address":1,
          "with_order":1,
          "with_ship_service":1,
          "with_shipment_items":1,
          "limit":100,"start":0}'

In order to notify RetailOps that a shipment is being processed, you or your vendor must acknowledge transmission of the shipment immediately upon pickup. You must not ship a RetailOps shipment prior to successful acknowledgement. This is necessary to ensure the shipment is not rerouted or edited while you are processing it. Shipment acknowledgement also ensures that a given shipment will be excluded from subsequent retrievals of "Ready" shipments.

To acknowledge receipt of a RetailOps shipment, use API call Fulfillment.Shipment.MarkTransmitted - Version 1. See a sample below.

curl -X POST 'https://api.gudtech.com/fulfillment/shipment/marktransmitted~1.json' \
    -H 'Content-Type: application/json' \
    -H 'apikey: YOUR_APIKEY_GOES_HERE' \
    -d '{ "records":[
          {
            "id": 178382,
            "estimated_ship_date":"2014-03-18T16:00:00-07:00",
            "latest_ship_date":"2014-03-20T16:00:00-07:00"
          }
       ]}'

When your vendor has concluded the fulfillment of a shipment--whether successfully in whole, successfully in part, or unsuccessfully--the disposition of this shipment must be conveyed to RetailOps. The following two API interactions will facilitate this.

For 3PL integrations, your 3PL vendor must receive an ASN notifying them of deliveries that are scheduled to be sent to their facility. ASNs may provide info on POs, BOLs, quantities, and configurations of items in shipment. This allows the vendor to plan space and allocate resources accordingly. Vendors must retrieve ASNs in “Pending” status.

Note that ASN generation must be turned on by RetailOps for each vendor.

To retrieve ASNs, use API call Fulfillment.ASN.fetch - Version 1. See a sample below.

curl -X POST 'https://api.gudtech.com/fulfillment/asn/fetch~1.json' \
    -H 'Content-Type: application/json' \
    -H 'apikey: YOUR_APIKEY_GOES_HERE' \
    -d '{
          "vendor_id":20,
          "status":"pending",
          "limit":10,"start":0
        }'

Once your 3PL vendor acknowledges that they have received an ASN, the ASN will no longer be retrieved by the ASN Retrieval call. Your 3PL vendor may acknowledge up to 100 ASNs per call.

To acknowledge receipt of ASNs, use API call Fulfillment.ASN.acknowledge - Version 1. See a sample below.

curl -X POST 'https://api.gudtech.com/fulfillment/asn/acknowledge~1.json' \
    -H 'Content-Type: application/json' \
    -H 'apikey: YOUR_APIKEY_GOES_HERE' \
    -d '{
          "id": [1,2,3],
        }'

External lots are lots stored by your 3PL vendor. Each lot represents the receipt of some quantity of an external SKU at a specific time. Your 3PL vendor must provide inventory advice to you regarding inventory levels. Your 3PL vendor may create up to 100 external lots per call.

To create external lots, use API call Inventory.ExternalLot.create - Version 1. Note that: 1. the parameter asn_item_id is highly preferred; 2. either SKU or VPC is required as a parameter, not both.

See a sample below.

curl -X POST 'https://api.gudtech.com/inventory/externallot/create~1.json' \
    -H 'Content-Type: application/json' \
    -H 'apikey: YOUR_APIKEY_GOES_HERE' \
    -d '{
          "records":[{
              "asn_item_id":12345,
              "date_created": "2015-01-01T00:00:00Z",
              "received_quantity": 10,
              "vpc": "ABC"
          },{
              "asn_item_id":12346,
              "date_created": "2015-01-01T00:00:00Z",
              "received_quantity": 1,
              "vpc": "XYZ"
          }],
          "vendor_id":123
        }'