Schedule a pickup

SecurityAuthToken

Request

Request Body schema: application/json
required

required	object (Address)
fedex_account	string or null <uuid>
is_regularly_scheduled	boolean
required	object (BasePointOfContact)
provider_carrier_code	string or null
provider_code required	string
scheduled_date required	string <date>
shipments	Array of strings <uuid>
special_instructions	string or null
time_window_end required	string <time>
time_window_start required	string <time>
ups_account	string or null <uuid>
usps_account	string or null <uuid>

Responses

200

Pickup details

Response Schema: application/json

required	object (Address)
fedex_account	string or null <uuid>
is_regularly_scheduled	boolean
required	object (BasePointOfContact)
provider_carrier_code	string or null
provider_code required	string
scheduled_date required	string <date>
	Array of objects <uuid> (SlimShipment)
special_instructions	string or null
time_window_end required	string <time>
time_window_start required	string <time>
ups_account	string or null <uuid>
usps_account	string or null <uuid>
cancelled_at	string or null <date-time>
created_at required	string <date-time>
id required	string <uuid>
pickup_number	string or null
provider_location_id	string or null
updated_at required	string <date-time>

default

Default error response

post/shipments/pickups/

Request samples

application/json

{"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"fedex_account": "9361f596-e74f-4d1f-9602-2b5ce417833d",
"is_regularly_scheduled": true,
"point_of_contact": {"email": "string",
"first_name": "string",
"job_title": "string",
"last_name": "string",
"phone_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z"
},
"provider_carrier_code": "string",
"provider_code": "string",
"scheduled_date": "2019-08-24",
"shipments": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"special_instructions": "string",
"time_window_end": "14:15:22Z",
"time_window_start": "14:15:22Z",
"ups_account": "43e7af52-5f49-4017-8eed-e936f62ae88f",
"usps_account": "ae0b00af-9d20-4200-9cec-344703d56477"
}

Response samples

200
default

application/json

{"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"fedex_account": "9361f596-e74f-4d1f-9602-2b5ce417833d",
"is_regularly_scheduled": true,
"point_of_contact": {"email": "string",
"first_name": "string",
"job_title": "string",
"last_name": "string",
"phone_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z"
},
"provider_carrier_code": "string",
"provider_code": "string",
"scheduled_date": "2019-08-24",
"shipments": [{"accessorials": [{"code": "string",
"currency_unit": "string",
"description": "string",
"id": 0,
"is_charge_code": true,
"long_description": "string",
"price": 0.1,
"type": "string"
}
],
"additional_bol_recipients": ["string"
],
"auction_stats": {"declined_quotes": 0,
"has_open_auction": true,
"lowest_bid": 0.1,
"messages": 0,
"most_recent_quote_created_at": "2019-08-24T14:15:22Z",
"negotiations": 0,
"quotes": 0,
"visible_companies": 0
},
"bol_number": "string",
"cancellation_reason": "string",
"capacity_provider_customer_reference_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_by_source": "SHIPWELL_WEB",
"created_by_user": {"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_name": "string",
"phone_number": "string"
},
"current_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z",
"reported_at": "2019-08-24T14:15:22Z"
},
"custom_data": {"property1": null,
"property2": null
},
"customer": {"billing_emails": ["string"
],
"brokerage": "b95bd339-ca09-4a33-afc0-236a62b0c8df",
"carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": "23591227-bb2c-4b6d-8a76-9588ed92086b",
"updated_at": "2019-08-24T14:15:22Z"
},
"customer_reference_number": "string",
"delayed": true,
"description": "string",
"documents_count": 0,
"drayage_booking_number": "string",
"drayage_carrier_scac_code": "string",
"drayage_chassis_number": "string",
"drayage_container_number": "string",
"drayage_container_return_date": "string",
"drayage_estimated_arrival_date": "string",
"drayage_house_bol_number": "string",
"drayage_last_free_date": "string",
"drayage_release_date": "string",
"drayage_seal_number": "string",
"equipment_config": {"carrier": {"display_name": "string",
"eld_providers": [{"connection_status": "Active",
"disconnection_reason": {"property1": null,
"property2": null
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_data_report": "2019-08-24T14:15:22Z",
"name": "string",
"tracking_status": "Active"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"primary_phone_number": "string",
"service_center_lookup_url": "string",
"usdot_number": "string"
},
"driver": {"app_last_opened_at": "2019-08-24T14:15:22Z",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_name": "string",
"phone_number": "string",
"pin": 0,
"platform": "iOS",
"user": {"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_name": "string",
"phone_number": "string"
}
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"power_unit": {"description": "string",
"from_eld_provider": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"provider": "string",
"status": "Active"
},
"trailer": {"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
},
"equipment_type": {"id": 0,
"machine_readable": "string",
"name": "string"
},
"est_trip_miles": 0.1,
"external_tracking_link": "string",
"final_trip_miles": 0.1,
"group_id": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_watchable": true,
"is_watched": true,
"last_cloned_at": "2019-08-24T14:15:22Z",
"line_items": [{"country_of_manufacture": "US",
"description": "string",
"freight_class": "50",
"hazmat_hazard_class": "string",
"hazmat_identification_number": "string",
"hazmat_packing_group": "I",
"hazmat_proper_shipping_name": "string",
"height": 0.1,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"length": 0.1,
"length_unit": "CM",
"nmfc_item_code": "string",
"nmfc_sub_code": "string",
"package_weight": 0.1,
"piece_type": "BAG",
"product_category": "string",
"product_ref": "string",
"provider_specific_packaging": "string",
"refrigeration_max_temp": 0.1,
"refrigeration_min_temp": 0.1,
"refrigeration_required": true,
"stackable": true,
"temp_unit": "F",
"value_per_piece": 0.1,
"value_per_piece_currency": "CAD",
"weight_unit": "KG",
"width": 0.1,
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"deleted_at": "2019-08-24T14:15:22Z",
"destination_stop": "9f2c2b22-33f4-4d9a-8d9e-5bae44ad8c1e",
"dry_ice_unit": "LB",
"dry_ice_weight": 0.1,
"formatted_description": "string",
"insured_value": 0,
"insured_value_currency": "CAD",
"is_hazmat": true,
"order_number": "string",
"origin_stop": "ef4efbd8-cdf3-4968-b2ef-9780904c11d1",
"package_type": "BAG",
"purchase_order": "94a9570d-82e2-4a81-b165-8cff67d9c735",
"purchase_order_line_item_id": "5c0f45e8-d007-4d03-89f8-bca35f15fdc7",
"serial_number": "string",
"total_line_item_weight": 0.1,
"total_packages": 0,
"total_pieces": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"marked_as_paid_by_user": "11a0a5f3-c5cd-4ba2-a712-5f479124aeb4",
"markup": 0.1,
"messages_count": 0,
"metadata": {"alert_level": "HIGH",
"alert_message": "string",
"alerts": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"level": "HIGH",
"message": "Driver does not have mobile app installed.",
"occurred_at": "2019-08-24T14:15:22Z",
"subtype": "APP_NOT_INSTALLED",
"type": "MOBILE_DEVICE_ALERT",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"archived": true,
"automation_enabled": true,
"bill_to_override": {"billing_id": "string",
"company_address": "string",
"company_name": "string",
"contact_email": "string",
"contact_phone": "string",
"created_at": "2019-08-24T14:15:22Z",
"direction": "PREPAID",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"updated_at": "2019-08-24T14:15:22Z"
},
"buy_it_now_amount": 0.1,
"buy_it_now_amount_currency": "CAD",
"bypass_carrier_insurance_coverage": true,
"custom_data": {"property1": null,
"property2": null
},
"customer_side_accessorial_charge_table": "03780f99-a096-4dc4-a351-129cc4d5e0d2",
"customer_side_fuel_surcharge_table": "85d7be30-58cb-483e-802f-a325ef01690e",
"has_open_auction": true,
"load_board_enabled": true,
"load_board_id": "string",
"max_buy_amount": 0,
"max_buy_amount_currency": "CAD",
"open": true,
"pending_tender_acceptance": true,
"tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"target_rate_amount": 0,
"target_rate_amount_currency": "CAD",
"v3_shipment_reference_id": "string",
"vendor_side_accessorial_charge_table": "5059cd31-61b4-43a0-93ad-eea18b3bd391",
"vendor_side_fuel_surcharge_table": "b63ebfdb-bbc7-45c3-b65a-019c19f8d5c4"
},
"mode": {"code": "string",
"description": "string",
"id": 0
},
"movement_type": "string",
"name": "string",
"next_planned_stop_id": "822d3372-10ca-4acf-91c2-017f6e0f1f1e",
"notes_count": 0,
"notes_for_carrier": "string",
"parcel_pickup_status": "CANCELLED",
"pickup_number": "string",
"preferred_currency": "CAD",
"pro_number": "string",
"purchase_order_number": "string",
"rail_car_number": "string",
"rail_car_status": "ARRIVAL_TRANSIT_LOCATION",
"reference_id": "string",
"references": [ ],
"relationship_to_customer": {"carrier_reference_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"customer": {"billing_emails": ["string"
],
"brokerage": "b95bd339-ca09-4a33-afc0-236a62b0c8df",
"carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": "23591227-bb2c-4b6d-8a76-9588ed92086b",
"updated_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"custom_data": {"property1": null,
"property2": null
},
"feature_flags": {"alerts_dashboard_enabled": true,
"analytics_enabled": true,
"automatic_carrier_policy_enabled": true,
"bid_manager_enabled": true,
"can_initiate_mobile_ping_tracking": true,
"can_override_bill_to_for_automated_ltl": true,
"ceva_enabled": true,
"ch_robinson_enabled": true,
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"contracts_enabled": true,
"edi_invoicing_enabled": true,
"fedex_enabled": true,
"freightwaves_driver_texts_enabled": true,
"ftl_instant_rates_enabled": true,
"genesis_ltl_enabled": true,
"historical_pricing_enabled": true,
"integrations_enabled": true,
"invoicing_enabled": true,
"load_board_enabled": true,
"mfa_enabled": true,
"netsuite_enabled": true,
"new_dashboard_enabled": true,
"order_consolidation_workflows_enabled": true,
"policies_enabled": true,
"purchase_orders_enabled": true,
"rate_tables_enabled": true,
"rmis_enabled": true,
"saferwatch_enabled": true,
"send_shipwell_network_enabled": true,
"show_load_board": true,
"stop_status_enabled": true,
"supplier_invites_enabled": true,
"triumph_pay_enabled": true,
"ups_enabled": true,
"uses_3pl_quoting_flow": true,
"usps_enabled": true
},
"identifying_codes": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"insurance_expires_at": "2019-08-24T14:15:22Z",
"insurance_policy_number": "string",
"insurance_provider_name": "string",
"insurance_provider_phone": "string",
"insurance_validated_at": "2019-08-24T14:15:22Z",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"maximum_driving_elevation_ft": 0,
"mileage_config_last_updated": "2019-08-24T14:15:22Z",
"mileage_type": "HERE_MAPS",
"primary_phone_number": "string",
"subdomain": "string"
},
"customer_charge_line_items": [{"amount": 0.1,
"category": "ACC",
"charge_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"unit_amount": 0.1,
"unit_amount_currency": "CAD",
"unit_name": "string",
"unit_quantity": 1,
"updated_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"prepaid_amount": 0.1,
"vendor_assignment": "a97f4721-ce89-4a5b-a56a-dde2b6583de2"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_assigned_carrier": true,
"updated_at": "2019-08-24T14:15:22Z",
"vendor": {"billing_emails": ["string"
],
"brokerage": "b95bd339-ca09-4a33-afc0-236a62b0c8df",
"carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": "23591227-bb2c-4b6d-8a76-9588ed92086b",
"updated_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"custom_data": {"property1": null,
"property2": null
},
"feature_flags": {"alerts_dashboard_enabled": true,
"analytics_enabled": true,
"automatic_carrier_policy_enabled": true,
"bid_manager_enabled": true,
"can_initiate_mobile_ping_tracking": true,
"can_override_bill_to_for_automated_ltl": true,
"ceva_enabled": true,
"ch_robinson_enabled": true,
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"contracts_enabled": true,
"edi_invoicing_enabled": true,
"fedex_enabled": true,
"freightwaves_driver_texts_enabled": true,
"ftl_instant_rates_enabled": true,
"genesis_ltl_enabled": true,
"historical_pricing_enabled": true,
"integrations_enabled": true,
"invoicing_enabled": true,
"load_board_enabled": true,
"mfa_enabled": true,
"netsuite_enabled": true,
"new_dashboard_enabled": true,
"order_consolidation_workflows_enabled": true,
"policies_enabled": true,
"purchase_orders_enabled": true,
"rate_tables_enabled": true,
"rmis_enabled": true,
"saferwatch_enabled": true,
"send_shipwell_network_enabled": true,
"show_load_board": true,
"stop_status_enabled": true,
"supplier_invites_enabled": true,
"triumph_pay_enabled": true,
"ups_enabled": true,
"uses_3pl_quoting_flow": true,
"usps_enabled": true
},
"identifying_codes": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"insurance_expires_at": "2019-08-24T14:15:22Z",
"insurance_policy_number": "string",
"insurance_provider_name": "string",
"insurance_provider_phone": "string",
"insurance_validated_at": "2019-08-24T14:15:22Z",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"maximum_driving_elevation_ft": 0,
"mileage_config_last_updated": "2019-08-24T14:15:22Z",
"mileage_type": "HERE_MAPS",
"primary_phone_number": "string",
"subdomain": "string"
},
"vendor_charge_line_items": [{"amount": 0.1,
"category": "ACC",
"charge_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"unit_amount": 0.1,
"unit_amount_currency": "CAD",
"unit_name": "string",
"unit_quantity": 1,
"updated_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"prepaid_amount": 0.1,
"vendor_assignment": "a97f4721-ce89-4a5b-a56a-dde2b6583de2"
}
],
"vendor_point_of_contact": "f21065b9-a4a6-4edb-bb46-20a9d9f7a8f0"
},
"relationship_to_vendor": {"carrier_reference_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"customer": {"billing_emails": ["string"
],
"brokerage": "b95bd339-ca09-4a33-afc0-236a62b0c8df",
"carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": "23591227-bb2c-4b6d-8a76-9588ed92086b",
"updated_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"custom_data": {"property1": null,
"property2": null
},
"feature_flags": {"alerts_dashboard_enabled": true,
"analytics_enabled": true,
"automatic_carrier_policy_enabled": true,
"bid_manager_enabled": true,
"can_initiate_mobile_ping_tracking": true,
"can_override_bill_to_for_automated_ltl": true,
"ceva_enabled": true,
"ch_robinson_enabled": true,
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"contracts_enabled": true,
"edi_invoicing_enabled": true,
"fedex_enabled": true,
"freightwaves_driver_texts_enabled": true,
"ftl_instant_rates_enabled": true,
"genesis_ltl_enabled": true,
"historical_pricing_enabled": true,
"integrations_enabled": true,
"invoicing_enabled": true,
"load_board_enabled": true,
"mfa_enabled": true,
"netsuite_enabled": true,
"new_dashboard_enabled": true,
"order_consolidation_workflows_enabled": true,
"policies_enabled": true,
"purchase_orders_enabled": true,
"rate_tables_enabled": true,
"rmis_enabled": true,
"saferwatch_enabled": true,
"send_shipwell_network_enabled": true,
"show_load_board": true,
"stop_status_enabled": true,
"supplier_invites_enabled": true,
"triumph_pay_enabled": true,
"ups_enabled": true,
"uses_3pl_quoting_flow": true,
"usps_enabled": true
},
"identifying_codes": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"insurance_expires_at": "2019-08-24T14:15:22Z",
"insurance_policy_number": "string",
"insurance_provider_name": "string",
"insurance_provider_phone": "string",
"insurance_validated_at": "2019-08-24T14:15:22Z",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"maximum_driving_elevation_ft": 0,
"mileage_config_last_updated": "2019-08-24T14:15:22Z",
"mileage_type": "HERE_MAPS",
"primary_phone_number": "string",
"subdomain": "string"
},
"customer_charge_line_items": [{"amount": 0.1,
"category": "ACC",
"charge_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"unit_amount": 0.1,
"unit_amount_currency": "CAD",
"unit_name": "string",
"unit_quantity": 1,
"updated_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"prepaid_amount": 0.1,
"vendor_assignment": "a97f4721-ce89-4a5b-a56a-dde2b6583de2"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_assigned_carrier": true,
"updated_at": "2019-08-24T14:15:22Z",
"vendor": {"billing_emails": ["string"
],
"brokerage": "b95bd339-ca09-4a33-afc0-236a62b0c8df",
"carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": "23591227-bb2c-4b6d-8a76-9588ed92086b",
"updated_at": "2019-08-24T14:15:22Z",
"billing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"custom_data": {"property1": null,
"property2": null
},
"feature_flags": {"alerts_dashboard_enabled": true,
"analytics_enabled": true,
"automatic_carrier_policy_enabled": true,
"bid_manager_enabled": true,
"can_initiate_mobile_ping_tracking": true,
"can_override_bill_to_for_automated_ltl": true,
"ceva_enabled": true,
"ch_robinson_enabled": true,
"company": "87340f10-f684-4b06-8427-5981380bd9a9",
"contracts_enabled": true,
"edi_invoicing_enabled": true,
"fedex_enabled": true,
"freightwaves_driver_texts_enabled": true,
"ftl_instant_rates_enabled": true,
"genesis_ltl_enabled": true,
"historical_pricing_enabled": true,
"integrations_enabled": true,
"invoicing_enabled": true,
"load_board_enabled": true,
"mfa_enabled": true,
"netsuite_enabled": true,
"new_dashboard_enabled": true,
"order_consolidation_workflows_enabled": true,
"policies_enabled": true,
"purchase_orders_enabled": true,
"rate_tables_enabled": true,
"rmis_enabled": true,
"saferwatch_enabled": true,
"send_shipwell_network_enabled": true,
"show_load_board": true,
"stop_status_enabled": true,
"supplier_invites_enabled": true,
"triumph_pay_enabled": true,
"ups_enabled": true,
"uses_3pl_quoting_flow": true,
"usps_enabled": true
},
"identifying_codes": [{"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"updated_at": "2019-08-24T14:15:22Z",
"value": "string"
}
],
"insurance_expires_at": "2019-08-24T14:15:22Z",
"insurance_policy_number": "string",
"insurance_provider_name": "string",
"insurance_provider_phone": "string",
"insurance_validated_at": "2019-08-24T14:15:22Z",
"mailing_address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"maximum_driving_elevation_ft": 0,
"mileage_config_last_updated": "2019-08-24T14:15:22Z",
"mileage_type": "HERE_MAPS",
"primary_phone_number": "string",
"subdomain": "string"
},
"vendor_charge_line_items": [{"amount": 0.1,
"category": "ACC",
"charge_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"unit_amount": 0.1,
"unit_amount_currency": "CAD",
"unit_name": "string",
"unit_quantity": 1,
"updated_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"prepaid_amount": 0.1,
"vendor_assignment": "a97f4721-ce89-4a5b-a56a-dde2b6583de2"
}
],
"vendor_point_of_contact": "f21065b9-a4a6-4edb-bb46-20a9d9f7a8f0",
"carrier_status": "ACTIVE",
"freight_authority_vendor_relationship": "2f0cec14-ac73-4280-bf2d-ca5dafd05bde"
},
"reps": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"role": {"id": 0,
"name": "string"
},
"user": {"avatar": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"completed_onboarding": true,
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"default_shipment_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"is_quoting_limited_user": true,
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"password": "string",
"permissions": ["string"
],
"phone_number": "string",
"subscribed_to_loadboard": true,
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z",
"verified_email": true
}
}
],
"rfqs": [{"autoquote": true,
"company_owner_id": "1003e640-8bcc-41af-b855-ef79a4ec4475",
"created_at": "2019-08-24T14:15:22Z",
"creator": {"avatar": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"completed_onboarding": true,
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"default_shipment_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"is_quoting_limited_user": true,
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"password": "string",
"permissions": ["string"
],
"phone_number": "string",
"subscribed_to_loadboard": true,
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z",
"verified_email": true
},
"did_finish_autoquote": true,
"equipment_types": [{"id": 0,
"machine_readable": "string",
"name": "string"
}
],
"has_parent_rfq": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"restrict_autoquote_to_companies": [{"billing_emails": [null
],
"brokerage": "b95bd339-ca09-4a33-afc0-236a62b0c8df",
"carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": "23591227-bb2c-4b6d-8a76-9588ed92086b",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
"shipment_modes": [{"code": "string",
"description": "string",
"id": 0
}
],
"spot_negotiations": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"updated_at": "2019-08-24T14:15:22Z"
}
],
"service_level": {"code": "string",
"description": "string",
"id": 0
},
"shipment_pickup": "ee3aacbb-db54-4cb4-b6ae-7fb1f7074d15",
"significantly_modified_at": "2019-08-24T14:15:22Z",
"state": "string",
"stops": [{"accessorials": [{"code": "string",
"currency_unit": "string",
"description": "string",
"id": 0,
"is_charge_code": true,
"long_description": "string",
"price": 0.1,
"type": "string"
}
],
"alerts": [{"alert_type": "AT_RISK",
"created_at": "2019-08-24T14:15:22Z",
"created_by_driver": "4b7764ea-906e-4a4e-9227-7c0083c9979c",
"created_by_user": "27517bc4-bc7e-445c-b9ea-ea9612f4fa59",
"description": "string",
"expiration": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"location": {"address_1": null,
"address_2": null,
"city": null,
"country": null,
"created_at": null,
"formatted_address": null,
"id": null,
"latitude": null,
"longitude": null,
"phone_number": null,
"postal_code": null,
"state_province": null,
"timezone": null,
"updated_at": null
},
"occurred_at": "2019-08-24T14:15:22Z",
"reason_code": "ACCIDENT",
"stop": "0bfa2243-0f07-4994-a5a2-d14bef007f26",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"appointment_needed": true,
"appointment_type": {"code": "string",
"id": 0,
"name": "string"
},
"appointment_window": {"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"carrier_specified_eta": {"created_at": "2019-08-24T14:15:22Z",
"initial_window_end": "2019-08-24T14:15:22Z",
"initial_window_start": "2019-08-24T14:15:22Z",
"running_window_end": "2019-08-24T14:15:22Z",
"running_window_start": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"confirmed_arrival_at": "2019-08-24T14:15:22Z",
"confirmed_departure_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"display_eta_window": "string",
"display_planned_window": "string",
"display_schedule": "string",
"eta_overridden_by": "42d07ec7-3b78-426f-8b1b-ad95f5bf150e",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instructions": "string",
"internal_notes": "string",
"is_completed": true,
"is_dropoff": true,
"is_pickup": true,
"location": {"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"latitude": 0.1,
"longitude": 0.1,
"phone_number": "string",
"postal_code": "string",
"state_province": "string",
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z"
},
"company_name": "string",
"created_at": "2019-08-24T14:15:22Z",
"created_using_address_book_entry_id": "string",
"dock_external_id": "string",
"facility_id": "string",
"facility_name": "string",
"friday_close_time": "14:15:22Z",
"friday_open_time": "14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identification_code": "string",
"location_name": "string",
"location_type": {"id": 0,
"name": "string"
},
"monday_close_time": "14:15:22Z",
"monday_open_time": "14:15:22Z",
"notes": "string",
"open_friday": true,
"open_monday": true,
"open_saturday": true,
"open_sunday": true,
"open_thursday": true,
"open_tuesday": true,
"open_wednesday": true,
"point_of_contacts": [{"email": null,
"first_name": null,
"job_title": null,
"last_name": null,
"phone_number": null,
"created_at": null,
"id": null,
"updated_at": null,
"load_board_enabled": null,
"load_board_invite_last_sent_at": null,
"preferences": null,
"user": null
}
],
"saturday_close_time": "14:15:22Z",
"saturday_open_time": "14:15:22Z",
"sunday_close_time": "14:15:22Z",
"sunday_open_time": "14:15:22Z",
"thursday_close_time": "14:15:22Z",
"thursday_open_time": "14:15:22Z",
"tuesday_close_time": "14:15:22Z",
"tuesday_open_time": "14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"wednesday_close_time": "14:15:22Z",
"wednesday_open_time": "14:15:22Z"
},
"ordinal_index": 0,
"planned_date": "string",
"planned_time_window_end": "14:15:22Z",
"planned_time_window_start": "14:15:22Z",
"planning_window": {"end": "2019-08-24T14:15:22Z",
"start": "2019-08-24T14:15:22Z"
},
"predictive_model_eta": {"created_at": "2019-08-24T14:15:22Z",
"initial_window_end": "2019-08-24T14:15:22Z",
"initial_window_start": "2019-08-24T14:15:22Z",
"running_window_end": "2019-08-24T14:15:22Z",
"running_window_start": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"sequence_number": 0,
"status": "AT_STOP",
"status_reason_code": "ACCIDENT",
"trip_management_eta": "2019-08-24T14:15:22Z",
"trip_management_eta_last_updated": "2019-08-24T14:15:22Z",
"unconfirmed_arrival_at": "2019-08-24T14:15:22Z",
"unconfirmed_departure_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"temperature_lower_limit": 0.1,
"temperature_upper_limit": 0.1,
"timeline_events": [{"actor": {"avatar": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"completed_onboarding": true,
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"default_shipment_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"is_quoting_limited_user": true,
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"password": "string",
"permissions": ["string"
],
"phone_number": "string",
"subscribed_to_loadboard": true,
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z",
"verified_email": true
},
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"description": "string",
"event_sub_type": "AT_DELIVERY",
"event_type": "AT_DELIVERY",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"occurred_at": "2019-08-24T14:15:22Z",
"source": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"timeline_last_updated_at": "2019-08-24T14:15:22Z",
"total_declared_value": 0.1,
"total_declared_value_currency": "CAD",
"total_linear_feet": 0,
"total_miles": 0.1,
"total_quantity_override": 0,
"total_weight_override": {"unit": "KG",
"value": 0.1
},
"tracking_number": "string",
"trailer_name": "string",
"updated_at": "2019-08-24T14:15:22Z",
"v3_shipment_id": "string",
"version": 2,
"current_carrier": {"billing_emails": ["string"
],
"brokerage": "b95bd339-ca09-4a33-afc0-236a62b0c8df",
"carrier": "faaa07f8-ed24-4408-95d3-1d7233f61a3e",
"created_at": "2019-08-24T14:15:22Z",
"dba_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_shipwell": true,
"name": "string",
"primary_email": "string",
"shipper": "23591227-bb2c-4b6d-8a76-9588ed92086b",
"updated_at": "2019-08-24T14:15:22Z"
}
}
],
"special_instructions": "string",
"time_window_end": "14:15:22Z",
"time_window_start": "14:15:22Z",
"ups_account": "43e7af52-5f49-4017-8eed-e936f62ae88f",
"usps_account": "ae0b00af-9d20-4200-9cec-344703d56477",
"cancelled_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"pickup_number": "string",
"provider_location_id": "string",
"updated_at": "2019-08-24T14:15:22Z"
}

Schedule a pickup

Request Body schema: application/jsonrequired

Response Schema: application/json

Request Body schema: application/json
required