PUT | /salesOrderShipment/tracking | Allows you to add a new tracking number to the order shipment. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ShipmentIncrementId | body | string | Yes | Shipment increment ID |
Carrier | body | string | Yes | Carrier code (ups, usps, dhl, fedex, or dhlint) |
Title | body | string | Yes | Tracking title |
TrackNumber | body | string | Yes | Tracking number |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
TrackingNumberId | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /salesOrderShipment/tracking HTTP/1.1
Host: avb-pos.avbportal.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"shipmentIncrementId":"String","carrier":"String","title":"String","trackNumber":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"trackingNumberId":0}