REST API Referenceloyalty fulfillments overview

/ws/merchants/{merch Ref}/loyalty/{Group Ref}/shipments/{ shipment Ref }

Methods: GET, POST, PUT, DELETE

GET

Retrieves details about a particular shipment.

POST

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

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

To see if a shipment has been finalized, check the EntryDate field. If it has a timestamp in it, then it has been finalized. A null value indicates an unfinalized shipment.

Example POST Request

        POST /ws/merchants/48034/loyalty/W11617/shipments/W870?action=finalize
                

PUT

Updates a shipment. Values for all keys may be modified with the exception of CardCount, EntryDate, ShipDate, and TrackingNum. Only modifies values for keys that are specified. Finalized shipments may not be modified.

DELETE

Deletes shipment. Returns nothing on success and an error message on failure.

Fields and Format

Please reference the bottom of this page to see a list of the available fields.

JSON Format:

        {
            "To":"someone",
            "Address1":"123 lane",
            "Address2":"box 123",
            "City":"Nolensville"
        }