post https://api.shippingscore.com/v1/transactions
Provide shipping transaction details.
Staging address is : https://staging.shippingscore.com/v1
The Transactions API is used to provide shipping translation details to the ShippingScore DB.
Staging Address
Staging address is : https://staging.shippingscore.com/v1
Address Verification/Validation
If you are sending a U.S. address that required validation, make sure to set "ShipmentToValidationFlag" to "0".
Examples
You want to submit a shipment to 1531 Forest Green Dr Coraopolis, PA, 15108 with a tracking number of 1234567. There is no shipment status to update as this is a new shipment.
Request Header:-
Content-Type: application/json;charset=UTF-8
Host: staging.shippingscore.com
Content-Length: 470
Expect: 100-continue
Connection: Keep-Alive
Request Body:-
{
"username":"YOURUSERNAME",
"apikey":"YOURAPIKEY",
// "TransactionType":"1", // Depracated 1/29/2015
"TrackingNo":"1234567",
"ShipmentToAddressLine1":"1234 Forest Green Dr",
"ShipmentToAddressLine2":"",
"ShipmentToCity":"Coraopolis",
"ShipmentToState":"PA",
"ShipmentToCountry":"US",
"ShipmentToZipCode":"15108",
"ShipmentToValidationFlag":"1",
"ShipmentCost":"500.00",
"ShipmentDate":"2014-10-22",
"ShipmentStatus":"1"
}
1 week after the previous shipment, you find out that the package was damaged in transit. You can then submit the update to flag it as "Damaged".
Request Header:-
Content-Type: application/json;charset=UTF-8
Host: staging.shippingscore.com
Content-Length: 437
Expect: 100-continue
Connection: Keep-Alive
Request Body:-
{
"username":"API USERNAME",
"apikey":"APIKey",
"TransactionType":"1",
"TrackingNo":"1234567",
"ShipmentToAddressLine1":"1531 Forest Green Dr",
"ShipmentToAddressLine2":"",
"ShipmentToCity":"Coraopolis",
"ShipmentToState":"PA",
"ShipmentToCountry":"US",
"ShipmentToZipCode":"15108",
"ShipmentToValidationFlag":"1",
"ShipmentCost":"500.00",
"ShipmentDate":"2014-10-28",
"ShipmentStatus":"3"
}
ShipmentStatus Types
| ID | Name | Description |
|---|---|---|
| 1 | Nothing | Used to report initial shipping transaction |
| 2 | Loss Package | The shipment was lost in transit or the recipient indicated such. |
| 3 | Damaged Package | The shipment was damaged in transit or the recipient indicated such. |
| 4 | Shortage | The shipment arrived with part of or all of the contents missing. |
| 5 | Tracking Non-Delivery | The shipment was not scanned as "Delivered" |
| 6 | Fraudulent Transaction | The merchant indicated the entire transaction to this address was fraud. |
| 7 | Chargeback | The recipient at the address filed a chargeback against the shipper. |
| 8 | Returned Package | The shipment was returned to sender. |
TransactionTypes Types - DEPRECATED 1/29/2015
| ID | Description |
|---|---|
| 1 | New Shipment |
| 2 | Update to an existing shipment. Used to update ShipmentStatus |