Create and tender a shipment to a Shipwell company

SecurityAuthToken

Request

Request Body schema: application/json
required

required	object (TenderRequestCustomer)
required	object (TenderRequestEquipment)
	object or null (TenderExternalEDISystem)
required	object (TenderRequestShipment)
required	object (TenderRequestVendor)

Responses

200

Shipment successfully tendered

Response Schema: application/json

required	object (TenderRequestCustomer)
required	object (TenderRequestEquipment)
	object or null (TenderExternalEDISystem)
required	object (TenderRequestShipment)
required	object (TenderRequestVendor)

default

Default error response

post/shipments/tenders/

Request samples

application/json

{"customer": {"duns": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"equipment": {"temperature_control": {"lower_limit": {"unit": "C",
"value": 0
},
"upper_limit": {"unit": "C",
"value": 0
}
},
"type_code": "BULK"
},
"isa": {"external_edi_system_isa_id": "string",
"external_edi_system_isa_id_qualifier": "st"
},
"shipment": {"accessorials": ["GUARANTEED"
],
"bol_number": "string",
"charges": [{"category": "ACC",
"unit_amount": 0.1,
"unit_name": "string",
"unit_quantity": 1
}
],
"drayage_booking_number": "string",
"drayage_chassis_number": "string",
"drayage_container_number": "string",
"drayage_seal_number": "string",
"expires_at": "2019-08-24T14:15:22Z",
"external_edi_system_shipment_id": "string",
"pickup_number": "string",
"pro_number": "string",
"purchase_order_number": "string",
"shipment_reference_id": "string",
"shipper_reference_id": "string",
"special_instructions": "string",
"stops": [{"accessorials": ["APPOINTMENT_REQUESTED"
],
"address": {"city": "string",
"country": "st",
"identification_code": "string",
"line_1": "string",
"line_2": "string",
"postal_code": "string",
"state_or_province": "st",
"timezone": "string"
},
"company_name": "string",
"contacts": [{"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string"
}
],
"earliest_pickup": "2019-08-24T14:15:22Z",
"latest_pickup": "2019-08-24T14:15:22Z",
"line_items": [{"description": "string",
"height": {"unit": "IN",
"value": 0.1
},
"length": {"unit": "IN",
"value": 0.1
},
"package_quantity": 0,
"package_type": "BAG",
"piece_quantity": 0,
"piece_type": "BAG",
"weight": {"unit": "KG",
"value": 0
},
"width": {"unit": "IN",
"value": 0.1
}
}
],
"reason": "LOAD",
"sequence_id": 1,
"special_instructions": "string"
}
],
"total_declared_value": "string",
"weight": {"unit": "KG",
"value": 0
}
},
"vendor": {"ff": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mc": "string",
"mx": "string",
"nsc": "string",
"scac": "string",
"usdot": "string"
}
}

Response samples

200
default

application/json

{"customer": {"duns": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
},
"equipment": {"temperature_control": {"lower_limit": {"unit": "C",
"value": 0
},
"upper_limit": {"unit": "C",
"value": 0
}
},
"type_code": "BULK"
},
"isa": {"external_edi_system_isa_id": "string",
"external_edi_system_isa_id_qualifier": "st"
},
"shipment": {"accessorials": ["GUARANTEED"
],
"bol_number": "string",
"charges": [{"category": "ACC",
"unit_amount": 0.1,
"unit_name": "string",
"unit_quantity": 1
}
],
"drayage_booking_number": "string",
"drayage_chassis_number": "string",
"drayage_container_number": "string",
"drayage_seal_number": "string",
"expires_at": "2019-08-24T14:15:22Z",
"external_edi_system_shipment_id": "string",
"pickup_number": "string",
"pro_number": "string",
"purchase_order_number": "string",
"shipment_reference_id": "string",
"shipper_reference_id": "string",
"special_instructions": "string",
"stops": [{"accessorials": ["APPOINTMENT_REQUESTED"
],
"address": {"city": "string",
"country": "st",
"identification_code": "string",
"line_1": "string",
"line_2": "string",
"postal_code": "string",
"state_or_province": "st",
"timezone": "string"
},
"company_name": "string",
"contacts": [{"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"phone": "string"
}
],
"earliest_pickup": "2019-08-24T14:15:22Z",
"latest_pickup": "2019-08-24T14:15:22Z",
"line_items": [{"description": "string",
"height": {"unit": "IN",
"value": 0.1
},
"length": {"unit": "IN",
"value": 0.1
},
"package_quantity": 0,
"package_type": "BAG",
"piece_quantity": 0,
"piece_type": "BAG",
"weight": {"unit": "KG",
"value": 0
},
"width": {"unit": "IN",
"value": 0.1
}
}
],
"reason": "LOAD",
"sequence_id": 1,
"special_instructions": "string"
}
],
"tender_id": "093ec6a4-447a-46bc-a74f-3fdca6cbb2f8",
"total_declared_value": "string",
"weight": {"unit": "KG",
"value": 0
}
},
"vendor": {"ff": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mc": "string",
"mx": "string",
"nsc": "string",
"scac": "string",
"usdot": "string"
}
}

Create and tender a shipment to a Shipwell company

Request Body schema: application/jsonrequired

Response Schema: application/json

Request Body schema: application/json
required