REST API Referenceretail-fulfillments overview

/ws/merchants/{merchant ID}/retail-fulfillments/{fulfillment ID}/shipments

Methods: GET, POST

GET

Retrieves a list of shipments.

POST

Acts upon the resource using the action parameter in the URI query string.

If you include JSON, you can update the shipment details and create it in one step.

Parameter	Type	Description
action	string	One of the following actions: create
ShipmentID	string	Used in conjunction with the create action. Must be unique for a particular merchant.

Example POST Request

      POST /ws/merchants/48034/retail-fulfillments/W11617/shipments?action=create&ShipmentID=2352
    

JSON Format

      [
        {
          "ShipmentID":"869",
          "To":"Manny Oswald",
          "Address1":"31415 Concentric Circle",
          "Address2":null,
          "City":"Austin",
          "State":"TX",
          "Zip":"59754",
          "ReturnName":"John Hutchinson",
          "ReturnFrom":"",
          "ReturnAddress1":"2948 Bickford Dr.",
          "ReturnAddress2":null,
          "ReturnCity":"Stillwater",
          "ReturnState":"OK",
          "ReturnZip":"40593-7735",
          "CardCount":1,
          "EntryDate":"2011-09-02 18:49:02",
          "ShipDate":"2011-09-05",
          "ShippingMethod":"Standard",
          "TrackingNum":null
        },
        {
          "ShipmentID":"870",
          "To":"Angela Stefano",
          "Address1":"123 Example Place",
          "Address2":"Apt. A-2",
          "City":"San Diego",
          "State":"CA",
          "Zip":"90739",
          "ReturnName":"Henry P. Chillingsworth",
          "ReturnFrom":"",
          "ReturnAddress1":"987 Cinnamon Street",
          "ReturnAddress2":null,
          "ReturnCity":"Seattle",
          "ReturnState":"WA",
          "ReturnZip":"98023",
          "CardCount":1,
          "EntryDate":"2011-09-02 18:49:02",
          "ShipDate":"2011-09-05",
          "ShippingMethod":"Overnight",
          "TrackingNum":"123456789"
        }
      ]
    

Fields

Please note that if you fill out the ReturnAddress, you must also pass a value for ReturnFrom.

Name	Type
ShipmentID	editable
To	editable
Address1	editable
Address2	editable
City	editable
State	editable
Zip	editable
ReturnName	editable
ReturnFrom	editable
ReturnAddress1	editable
ReturnAddress2	editable
ReturnCity	editable
ReturnState	editable
ReturnZip	editable
CardCount	read-only
EntryDate	read-only
ShipDate	read-only
ShippingMethod	editable
TrackingNum	read-only