Payloads for Shipper
10 available Payloads for Shippers
{
"id": 0,
"name": "string",
"comment": "string",
"internal_ref": null,
"departure_date": "2024-11-15",
"departure_date_to": "2024-11-16",
"departure_time": "11:00:00",
"departure_time_to": "11:00:00",
"arrival_date": "2024-11-20",
"arrival_date_to": "2024-11-21",
"arrival_time": null,
"arrival_time_to": null,
"from_address": {
"id": 0,
"type": "string",
"name": "string",
"country": "string",
"city": "string",
"address_1": "string",
"address_2": null,
"recipient": "string",
"zipcode": "string",
"state": null,
"phone_number": "string",
"email": null,
"instructions": null,
"country_code_alpha2": "FR",
"internal_ref": null
},
"dest_address": {
"id": 0,
"type": "string",
"name": "string",
"country": "string",
"city": "string",
"address_1": "string",
"address_2": "string",
"recipient": "string",
"zipcode": "string"",
"state": null,
"phone_number": "string",
"email": null,
"instructions": null,
"country_code_alpha2": "FR",
"internal_ref": null
},
"accounting_entity_id": null,
"booker": {
"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
},
"pre_shipments": [
{
"id": 0,
"name": "string",
"contents": [
{
"id": 0,
"type_id": 0,
"type": {
"id": 0,
"name": "string",
"is_container": false
},
"spec_id": 0,
"quantity": 0,
"length": 0,
"width": 0,
"height": 0,
"weight": 0,
"comment": "string",
"product_type_id": 0,
"productType": {
"id": 0,
"name": "string"
}
}
],
"total_volume": null,
"total_weight": null,
"total_linear_meters": null,
"from_address": {
"id": 0,
"type": "string",
"name": "string"",
"country": "string"",
"city": "string",
"address_1": "string"",
"address_2": null,
"recipient": "string",
"zipcode": "string",
"state": null,
"phone_number": "string"8",
"email": null,
"instructions": null,
"country_code_alpha2": "FR",
"internal_ref": null
},
"dest_address": {
"id": 0,
"type": "string",
"name": "string",
"country": "string",
"city": "string",
"address_1": "string",
"address_2": null
"recipient": "string",
"zipcode": "string",
"state": null,
"phone_number": "string",
"email": null,
"instructions": "string",
"country_code_alpha2": "FR",
"internal_ref":"string"
},
"purchase": "",
"sales": "",
"requested_date_time": {
"departure_date_from": "2024-11-15",
"departure_date_to": "2024-11-16",
"departure_time_from": "11:00:00",
"departure_time_to": "11:00:00",
"arrival_date_from": "2024-11-20",
"arrival_date_to": "2024-11-21",
"arrival_time_from": null,
"arrival_time_to": null
}
}
],
"logistic_means": {
"product_type_name": null,
"type": {
"name": null
}
},
"quote_requests": [
{
"id": 0,
"currency": "EUR",
"mode": {
"id": 3,
"name": "Road"
},
"price_details": [
{
"name": "string",
"price": 0
},
{
"name": "string",
"price": 0
},
],
"carrier": {
"id": 0,
"name": "string",
"code": "string",
"scac": ""string"
},
"shiptify_link": "string"
},
{
"id": 0,
"currency": "EUR",
"mode": {
"id": 3,
"name": "Road"
},
"price_details": [
{
"name": "string",
"price": 0
},
{
"name": "string",
"price": 0
},
],
"carrier": {
"id": 0,
"name": "string",
"code": "string",
"scac": "string"
},
"shiptify_link": "string"
}
],
"carriers": [
{
"id": 0,
"name": "string",
"code": "string",
"scac": "string"
},
{
"id": 0,
"name": "string",
"code": "string",
"scac": "string"
}
],
"event_type": "create_shipment_request",
"accounting_entity": {},
"timestamp": 1731655917,
"signature": "string"
"token": "string"
}{ "event_type": "freight_unit_create_shipment", "shipment_id": 0, "freight_units": [{ "id": 1, "name": null, "internal_ref": "string", "contents": [{ "id": 0, "type_id": 0, "spec_id": null, "product_type_id": null, "quantity": 1, "length": 0, "width": 0, "height": 0, "weight": 0, "comment": null, "internal_ref": null, "is_dangerous": false, "is_stacked": false, "onu_code": null, "is_controlled_temperature": false, "from_address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": "", "recipient": "", "zipcode": "string", "state": "string", "phone_number": "string", "email": null, "instructions": "", "country_code_alpha2": "FR", "internal_ref": "string" }, "dest_address": { "id": 0, "type": "head_office", "name": "string", "country": "France", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "type": { "id": 0, "name": "Palette 100*120", "is_container": false }, "freight_unit_key": null, "product_type_name": null, "spec_name": null }] },{ "id": 2, "name": null, "internal_ref": "FU key2", "contents": [{ "id": 0, "type_id": 0, "spec_id": null, "product_type_id": null, "quantity": 2, "length": 0, "width": 0, "height": 0, "weight": 0, "comment": null, "internal_ref": null, "is_dangerous": false, "is_stacked": false, "onu_code": null, "is_controlled_temperature": false, "from_address": null, "dest_address": null, "type": { "id": 0, "name": "Box 60 30 30", "is_container": false }, "freight_unit_key": null, "product_type_name": null, "spec_name": null }] }], "timestamp": 1652950379, "signature": "225fb4f836606ffe44c449a8c06a35fda29526434eb476967cdbf51f97e4643d", "token": "f62c3148f4bcbb146e653eed27ce8e29166986e34b1c6e498d90ebe2bc590531542c5de4043a97809f9aed9370ad8cc99006" }
{ "event_type": "freight_unit_update_shipment_contents", "shipment_id": 49981, "added_freight_units": [ { "id": 3, "name": null, "internal_ref": "string", "contents": [ { "id": 0, "type_id": 0, "spec_id": 0, "product_type_id": 0, "quantity": 1, "length": 60, "width": 30, "height": 30, "weight": 0, "comment": "", "internal_ref": null, "is_dangerous": false, "is_stacked": false, "onu_code": null, "is_controlled_temperature": false, "from_address": null, "dest_address": null, "type": { "id": 7, "name": "Box 60 30 30", "is_container": false }, "freight_unit_key": null, "product_type_name": null, "spec_name": null } ] } ], "changed_freight_units": [ { "id": 1, "name": null, "internal_ref": "FU key1", "contents": [ { "id": 0, "type_id": 0, "spec_id": 0, "product_type_id": 0, "quantity": 1, "length": 0, "width": 0, "height": 0, "weight": 0, "comment": "", "internal_ref": null, "is_dangerous": false, "is_stacked": false, "onu_code": null, "is_controlled_temperature": false, "from_address": null, "dest_address": null, "type": { "id": 6, "name": "Others", "is_container": false }, "freight_unit_key": null, "product_type_name": null, "spec_name": null }, { "id": 0, "type_id": 0, "spec_id": 0, "product_type_id": 0, "quantity": 5, "length": 120, "width": 100, "height": 0, "weight": 0, "comment": null, "internal_ref": null, "is_dangerous": false, "is_stacked": false, "onu_code": null, "is_controlled_temperature": false, "from_address": { "id": 0, "type": "string", "name": "string", "country": "France", "city": "Nantes", "address_1": "133 Rue de coulmiers", "address_2": "", "recipient": "", "zipcode": "44000", "state": "string", "phone_number": "string", "email": null, "instructions": "", "country_code_alpha2": "FR", "internal_ref": "string" }, "dest_address": { "id": 38746, "type": "head_office", "name": "string", "country": "France", "city": "Bonneville", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "74130", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "type": { "id": 15, "name": "Palette 100*120", "is_container": false }, "freight_unit_key": null, "product_type_name": null, "spec_name": null } ] } ], "deleted_freight_units": [ { "id": 0, "name": null, "internal_ref": "FU key7" } ], "timestamp": 1652959319, "signature": "e7508892bb794be510ec899f162f08a0c335cc8ed976bf0551a4205a925843c0", "token": "26987558a6c6640e8260a9fa7f8bf0ecff92ac99703e759493e9444572073bb5108e2e4fb8302e4750deaf1454a0cd237cd5" }
{ "event_type": "freight_unit_update_tracking", "shipment_id": 0, "updated_tracking_point_id": 0, "freight_units": [{ "id": 1, "name": null, "internal_ref": "FU key1", "contents": [{ "id": 0, "type_id": 15, "spec_id": null, "product_type_id": null, "quantity": 1, "length": 120, "width": 100, "height": 0, "weight": 0, "comment": null, "internal_ref": null, "is_dangerous": false, "is_stacked": false, "onu_code": null, "is_controlled_temperature": false, "from_address": { "id": 0, "type": "other", "name": "STY", "country": "France", "city": "Nantes", "address_1": "133 Rue de Coulmiers", "address_2": "", "recipient": "", "zipcode": "44000", "state": "string", "phone_number": "string", "email": null, "instructions": "", "country_code_alpha2": "FR", "internal_ref": "string" }, "dest_address": { "id": 0, "type": "head_office", "name": "STY Logistique Internationale", "country": "France", "city": "Bonneville", "address_1": "string", "address_2": null, "recipient": "STY Logistique Internationale", "zipcode": "74130", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "type": { "id": 0, "name": "Palette 100*120", "is_container": false }, "freight_unit_key": null, "product_type_name": null, "spec_name": null }] },{ "id": 2, "name": null, "internal_ref": "FU key2", "contents": [{ "id": 0, "type_id": 0, "spec_id": null, "product_type_id": null, "quantity": 2, "length": 60, "width": 30, "height": 30, "weight": 0, "comment": null, "internal_ref": null, "is_dangerous": false, "is_stacked": false, "onu_code": null, "is_controlled_temperature": false, "from_address": null, "dest_address": null, "type": { "id": 0, "name": "Box 60 30 30", "is_container": false }, "freight_unit_key": null, "product_type_name": null, "spec_name": null }] }], "tracking_details": { "id": 0, "position": 1, "type": "departure", "comment": "", "incident": null, "planned_date": "2022-05-19", "real_date": "2022-05-19", "planned_time": "11:45:00", "real_time": "09:53:00", "code": "STY0000", "address": { "id": 0, "type": "store", "name": "Paris STY", "country": "France", "city": "Paris", "address_1": "string", "address_2": null, "recipient": null, "zipcode": "75002", "state": "string", "phone_number": "+335291112233", "email": "test @ shiptify.com", "instructions": null, "country_code_alpha2": "FR", "internal_ref": null } }, "timestamp": 1652950424, "signature": "016bf8d82132c438f98b7e1faa8bce606b57d329ff991b0040a7fd95848088af", "token": "0db5f2f676f5557bf0b753068fa49f0778fe0fb7a9bbf9f43086a2f4bb8c83b3718d45666813f596b1b65553668ab58d2141" }
{ "id": 0, "shipper_id": 0, "carrier_id": 0, "status": "planned", "tracking_code": null, "name": "string", "container_name": null, "quote_request_id": 0, "estimated_departure": "2022-01-27T02:00:00.000Z", "real_departure": null, "is_full_day_departure": false, "estimated_arrival": "2021-12-15T23:00:00.000Z", "real_arrival": null, "is_full_day_arrival": false, "total_volume": 0, "total_weight": 0, "total_linear_meters": 0, "from_address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "dest_address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "contents": [{ "id": 0, "type_id": 0, "spec_id": 0, "product_type_id": 0, "quantity": 0, "length": 0, "width": 0, "height": 0, "weight": 0, "comment": "string", "internal_ref": null, "is_dangerous": true, "is_stacked": true, "onu_code": null, "is_controlled_temperature": false, "from_address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": null, "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": null, "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "dest_address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": "string", "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": "string" }, "type": { "id": 0, "name": "string", "is_container": false }, "freight_unit_key": "string", "product_type_name": "string", "spec_name": "string" }], "incoterms": { "purchase": "", "sales": "" }, "routing_details": [], "shipment_request": { "id": 0, "name": "string", "comment": "", "internal_ref": null, "departure_date": "2022-01-21", "departure_time": "12:30:00", "arrival_date": "2022-01-28", "arrival_time": "13:00:00", "from_address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "dest_address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null }, "prices": [{ "price": "1.000", "status": "agreed", "init_price": "1.000", "name": "Freight" }, { "price": "2.000", "status": "agreed", "init_price": "2.000", "name": "Admin" }, { "price": "3.000", "status": "agreed", "init_price": "3.000", "name": "Security" }, { "price": "4.000", "status": "agreed", "init_price": "4.000", "name": "Others" }] }, "shipment_mode": { "id": 3, "name": "Road" }, "tracking_points": [{ "id": 0, "position": 10000, "type": "arrival", "comment": null, "incident": null, "planned_date": "2021-12-15", "real_date": null, "planned_time": "23:00:00", "real_time": null, "code": "STY9999", "address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null } }, { "id": 0, "position": 0, "type": "departure", "comment": "", "incident": null, "planned_date": "2022-01-27", "real_date": null, "planned_time": "02:00:00", "real_time": "13:32:00", "code": "STY0000", "address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null } }], "carrier": { "id": 33, "name": "string", "code": "string", "scac": null }, "event_type": "create_shipment", "timestamp": 1643117545594, "signature": "string", "token": "string" }
{
"id": 0,
"name": "String",
"internal_ref": "String",
"status": "pending",
"date_time": "2024-03-04T09:30:00.000Z",
"location_id": 0,
"carrier_id": 0,
"carrier_name": "String",
"authorization_in_min": null,
"authorization_in_max": null,
"authorization_out_min": null,
"authorization_out_max": null,
"comment": "String",
"drivers": [
{
"driver_id_key": 0,
"driver_id_internal_key": "M.Mouse",
"first_name": "Mickey",
"last_name": "Mouse",
"document_type": "String",
"document_number": "MIC25833",
"phone": "String",
"is_blocked": false,
"is_checked": false
}
],
"transports": [
{
"truck_license_plate": "MICKEY",
"trailer_license_plate": "MOUSE",
"is_checked": false
}
],
"slots": [
{
"id": 0,
"name": "Cartoon anvils",
"internal_ref": "String",
"action_type": "delivery",
"status": "new",
"internal_zone_id": "HeavyEquip",
"dock_door_name": "RED",
"partner_name": "Disney movies",
"date_time": "2024-03-04T09:30:00.000Z",
"date_time_to":"2024-03-04T10:00:00.000Z"
"calculated_slot_duration":30,
"manual_slot_duration":null,
"comment": "String",
"metadata": [
{
"prototype_id": 86,
"value": "Scotland"
}
],
"contents":[
{
"type_id":1,
"quantity": 20,
}
]
"orders": [
{
"number": "String",
"company_name": null,
"type_id": 1,
"quantity": 20,
"product_type_id": null,
"customer_id": "String"
}
]
},
{
"id": 0,
"name": "Cartoon Prince",
"internal_ref": "String",
"action_type": "pick-up",
"status": "new",
"internal_zone_id": "EXPALL",
"dock_door_name": "Main",
"partner_name": "Disney movies",
"date_time": "2024-03-04T10:10:00.000Z",
"date_time_to":"2024-03-04T10:10:00.000Z"
"calculated_slot_duration":10,
"manual_slot_duration":null,
"comment": "Prince - 1 piece. Someone should wake up Sleeping Beauty...",
"metadata": [
{
"prototype_id": 86,
"value": "String"
}
],
"contents":[
{
"type_id": 1,
"quantity": 1,
}
{
"type_id": 1,
"quantity": 1,
}
]
"orders": [
{
"id":0,
"internal_ref":"String",
"number": "String",
"company_name": null,
"type_id": 1,
"quantity": 1,
"goods_type_id": null,
"goods_type_name":"String"
"customer_id": "String"
},
{
"id":0,
"internal_ref":"string",
"number": "String",
"company_name": null,
"type_id": 1,
"quantity": 1,
"goods_type_id": null,
"goods_type_name":"String"
"customer_id": "ToonTBC"
}
]
}
],
"event_type": "create_visit",
"timestamp": 1709547945,
"signature": "string",
"token": "string"
}{ "id": 0, "shipper_id": 0, "carrier_id": 0, "status": "planned", "tracking_code": null, "name": "string", "container_name": null, "quote_request_id": 0, "estimated_departure": "2022-01-27T02:00:00.000Z", "real_departure": null, "is_full_day_departure": false, "estimated_arrival": "2021-12-15T23:00:00.000Z", "real_arrival": null, "is_full_day_arrival": false, "shipment_mode": { "id": 3, "name": "Road" }, "updated_tracking_point_id": 0, "tracking_points": [{ "id": 0, "position": 10000, "type": "arrival", "comment": null, "incident": null, "planned_date": "2021-12-15", "real_date": null, "planned_time": "23:00:00", "real_time": null, "code": "STY9999", "address": { "id": 0, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null } }, { "id": 0, "position": 0, "type": "departure", "comment": "", "incident": null, "planned_date": "2022-01-27", "real_date": null, "planned_time": "02:00:00", "real_time": "13:32:00", "code": "STY0000", "address": { "id": 42920, "type": "string", "name": "string", "country": "string", "city": "string", "address_1": "string", "address_2": null, "recipient": "string", "zipcode": "string", "state": null, "phone_number": "string", "email": null, "instructions": null, "country_code_alpha2": "FR", "internal_ref": null } }], "event_type": "update_tracking", "timestamp": 1643117544684, "signature": "string", "token": "string" }
{
"shipment_id": 123456,
"sh_request_id": 45678,
"attachment_id": 12345,
"doc_type": "proof_of_delivery",
"file_name": "XXXXXXXXXX",
"status": "active",
"event_type": "upload_shipment_attachment",
"timestamp": 1694503397,
"signature": "string",
"token": "string"
}{
"id": 181,
"invoice_type": "invoice",
"number": "IN 2023 07 - 000004",
"status": "new",
"price": "2500.000",
"currency_code": "EUR",
"creation_date": "2023-09-12",
"assigned_date": "2023-07",
"issue_date": "2023-08-09",
"due_date": "2023-09-23",
"pre_invoice_id": null,
"shipper_id": 4,
"shipper_internal_id1": "internal_SH-1",
"shipper_internal_id2": "",
"carrier_id": 7,
"carrier_internal_id1": "cIntId1",
"carrier_internal_id2": "cIntId2",
"booking_invoicings": [],
"payment_term": null,
"event_type": "create_invoice",
"timestamp": 1694504504,
"signature": "string",
"token": "string"
}{
"location_id": 0,
"internal_zone_id": "string",
"carrier_id": 0,
"carrier_name": "string",
"slot_status": "new",
"visit_status": "pending",
"duration": 30,
"contents": [],
"slots": [
{
"id": 0,
"internal_ref": "string",
"visit_id": 0,
"visit_internal_ref": "string",
"grouping_id": 0,
"date_time": "2024-11-13T09:00:00.000Z"
},
{
"id": 0,
"internal_ref": "string",
"visit_id": 0,
"visit_internal_ref": "string",
"grouping_id": 0,
"date_time": "2024-11-14T09:00:00.000Z"
},
{
"id": 0,
"internal_ref": "string",
"visit_id": 0,
"visit_internal_ref": "string",
"grouping_id": 0,
"date_time": "2024-11-11T09:00:00.000Z"
},
{
"id": 0,
"internal_ref": "string",
"visit_id": 0,
"visit_internal_ref": "string",
"grouping_id": 0,
"date_time": "2024-11-12T09:00:00.000Z"
},
{
"id": 0,
"internal_ref": "string",
"visit_id": 0,
"visit_internal_ref": "string",
"grouping_id": 0,
"date_time": "2024-11-15T09:00:00.000Z"
}
],
"event_type": "create_recurring_slot",
"timestamp": 1730998825,
"signature": "string",
"token": "string"
}Last updated