REST API Referenceloyalty fulfillments overview

/ws/merchants/{merchRef}/loyalty/{FulfillmentID}/shipments

Methods: GET, POST

GET

Retrieves a list of shipments.

Example GET Response

The following is an example JSON response to a GET call:

      [
          {
              "ShipmentRef":"W63731",
              "To":"someone",
              "Address1":"123 lane",
              "Address2":"box 123",
              "City":"Nolensville",
              "State":"TN",
              "Zip":"37135",
              "ReturnName":"John",
              "ReturnFrom":"Doe",
              "ReturnAddress1":"9999 street",
              "ReturnAddress2":"building 2",
              "ReturnCity":"Nolensville",
              "ReturnState":"TN",
              "ReturnZip":"37153",
              "CardCount":1,
              "EntryDate":"2015-05-14 15:21:05",
              "ShipDate":"2015-05-20",
              "ShippingMethod":"2Day",
              "TrackingNum": "1z23hf6wg4657ffjeje8tr"
          },
          {
              "ShipmentRef":"W63732",
              "To":"someone else",
              "Address1":"2143 street",
              "Address2":"",
              "City":"Nolensville",
              "State":"TN",
              "Zip":"37135",
              "ReturnName":"Someone",
              "ReturnFrom":"Someone",
              "ReturnAddress1":"9898 road",
              "ReturnAddress2":"",
              "ReturnCity":"Nolensville",
              "ReturnState":"TN",
              "ReturnZip":"37153",
              "CardCount":1,
              "EntryDate":"2015-05-14 15:21:05",
              "ShipDate":null,
              "ShippingMethod":"2 Days",
              "TrackingNum":null
          }
      ]
                

POST

Acts upon the resource using the action parameter in the URI query string. Using the create action will create a new shipment.

Parameter	Type	Description
action	string	One of the following actions: create

Example POST Request

      POST /ws/merchants/48034/loyalty/Red%20Gift%20Card/shipments?action=create
                

Example POST Response

      {"ShipmentRef":"W78243"}
                

Fields

Name	Data Type	Type
ShipmentRef	VARCHAR(51)	editable
To	VARCHAR(75)	editable
Address1	VARCHAR(50)	editable
Address2	VARCHAR(50)	editable
City	VARCHAR(30)	editable
State	VARCHAR(3)	editable
Zip	VARCHAR(15)	editable
ReturnName	VARCHAR(75)	editable
ReturnAddress1	VARCHAR(50)	editable
ReturnAddress2	VARCHAR(50)	editable
ReturnCity	VARCHAR(30)	editable
ReturnState	VARCHAR(3)	editable
ReturnZip	VARCHAR(15)	editable
CardCount	INTEGER	Read Only
EntryDate	DATETIME	Read Only
ShipDate	DATETIME	Read Only
ShippingMethod	STRING	editable
TrackingNum	STRING	Read Only