Documentation
>
>
Shipment Rating

Order Management

Shipment Rating

Use the https://app.ship.com/public/rate endpoint to request a shipping rate

Address

Shipping Information

Items

Request Example

1{
2  "FromAddress": {
3    "FirstName": "string",
4    "LastName": "string",
5    "Email": "string",
6    "Phone": "string",
7    "Address1": "string",
8    "Address2": "string",
9    "Address3": "string",
10    "City": "string",
11    "State": "string",
12    "Zip": "string",        // *required
13    "Country": "string"     // *required
14  },
15  "ToAddress": {
16    "FirstName": "string",
17    "LastName": "string",
18    "Email": "string",
19    "Phone": "string",
20    "Address1": "string",
21    "Address2": "string",
22    "Address3": "string",
23    "City": "string",
24    "State": "string",
25    "Zip": "string",        // *required
26    "Country": "string"     // *required
27  },
28  "BoxInformation": {
29    "Weight": "decimal",    // *required
30    "Length": "decimal",    // *required
31    "Height": "decimal",    // *required
32    "Width": "decimal",     // *required
33    "PackageType": "string" // *required ["Box", "Softpack"]
34  },
35  "ShippingInformation": {
36    "SaturdayDelivery": "bool",
37    "SignatureRequired": "bool",
38    "Insurance": "bool"
39  },
40  "Items": [
41    {
42      "ItemCode": "string",
43      "UPC": "string",
44      "Price": "decimal",
45      "Quantity": "string",
46      "HTSCode": "string",
47      "Weight": "decimal"
48    }
49  ]
50}

Successful Response Example

1{
2  "success": true,
3  "result": {
4    "FromAddress": {
5      "FirstName": "string",
6      "LastName": "string",
7      "Email": "string",
8      "Phone": "string",
9      "Address1": "string",
10      "City": "string",
11      "State": "string",
12      "Zip": "string",
13      "Country": "string"
14    },
15    "ToAddress": {
16      "FirstName": "string",
17      "LastName": "string",
18      "Email": "string",
19      "Phone": "string",
20      "Address1": "string",
21      "City": "string",
22      "State": "string",
23      "Zip": "string",
24      "Country": "string"
25    },
26    "BoxInformation": {
27      "Weight": "decimal",
28      "Length": "decimal",
29      "Height": "decimal",
30      "Width": "decimal",
31      "PackageType": "string"
32    },
33    "ShippingInformation": {
34      "ShippingMethod": "string",
35      "SaturdayDelivery": "bool",
36      "SignatureRequired": "bool",
37      "Insurance": "bool"
38    },
39    "ShipmentInformation": {
40      "RateId": "string",
41      "TrackingNumber": "string",
42      "LabelUrl": "string",
43      "Base64Label": "string",
44      "Base64Form": "string",
45      "ShippingCost": "decimal"
46    },
47    "Total": "decimal",
48    "SalesTax": "decimal",
49    "Handling": "decimal",
50    "Subtotal": "decimal",
51    "Shipping": "decimal",
52    "Discount": "decimal",
53    "InvoiceNumber": "string"
54  }
55}

Error Response Example

1{ "success": false, "error": "string" }