AVB LINQ Public API

<back to all web services

SalesOrderShipmentAddTrackRequest

Magento Sales
The following routes are available for this service:
PUT/salesOrderShipment/trackingAllows you to add a new tracking number to the order shipment.
SalesOrderShipmentAddTrackRequest Parameters:
NameParameterData TypeRequiredDescription
ShipmentIncrementIdbodystringYesShipment increment ID
CarrierbodystringYesCarrier code (ups, usps, dhl, fedex, or dhlint)
TitlebodystringYesTracking title
TrackNumberbodystringYesTracking number
SalesOrderShipmentAddTrackResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TrackingNumberIdformintNo

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

HTTP + JSON

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}