carrierDescription (required: if carrierCode is given) (string:200) : carrier name.
shipDate (optional) (date): new shipping date (date format YYYY-MM-DD).
poNumber (optional) (string:20) : new customer PO#.
reference (optional) (string:20): new reference or way bill number.
warehouseInstructions (optional) (string:200): new instructions for warehouse.
invoiceNotes (optional) (string:200): new notes that will be printed on the invoice.
You can use either carrierId or carrierCode and carrierName but you cannot use both parameters at the same time. We recommend using the carrierId which can be obtained from the carrier.list API method.
Sample Request
{
"authenticationToken": "token_info_goes_here",
"invoiceId": 345345,
"carrierId": 1878,
"shipDate": "2014-04-11",
"poNumber": "P099999",
"reference" : "R99999",
"warehouseInstructions": "New instructions",
"invoiceNotes": "New notes for the invoice"
}
Response
Output
status (integer:1): transaction status. 1 for success or 0 for failure.
message (string:500): description of the status of the transaction.