Skip to content

Create Ship To

Create a new ship-to location in Last Mile Intelligence.

createShipTo

shipTo

ParameterTypeRequiredDefaultDescription
Ship To DataJSONYes-Ship-to object with required fields
FieldTypeRequiredDescription
customerIdstringYesAssociated customer ID
namestringYesLocation name
addressobjectYesAddress object
deliveryInstructionsstringNoDelivery notes
contactNamestringNoOn-site contact name
contactPhonestringNoOn-site contact phone
{
"id": "ship_new123",
"customerId": "cust_xyz789",
"name": "New Location",
"address": {
"street": "123 New St",
"city": "Chicago",
"state": "IL",
"zip": "60601"
},
"createdAt": "2024-06-21T09:00:00Z"
}
{
"success": false,
"error": "Validation failed",
"details": {
"customerId": "Customer not found"
}
}
  • Missing API Token: LMI credential is missing API token
  • Customer Not Found: Customer ID does not exist
  • Geocoding Failed: Could not geocode the address
  • Validation Error: Required fields missing or invalid
  • Permission Denied: API token lacks permission for this operation