REST API Referenceretail-fulfillments overview

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

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/retail-fulfillments/W11617/shipments/870?action=finalize
    

PUT

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

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

DELETE

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

JSON Format

Please reference JSON Format.