List all Shipment Templates for the authenticated company

SecurityAuthToken
Request
query Parameters

q	string Search across template fields
template_name	string Filter across shipment templates by name
Responses
200
List of shipment templates
Response Schema: application/json

page_size	integer
	Array of objects (ShipmentTemplateResponse)
total_count	integer
total_pages	integer
default
Default error response
get/shipments/templates/
Request samples
curl
Node.js
JavaScript
Python
Java
Response samples
200
default
application/json
{"page_size": 0,
"results": [{"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"
],
"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"
},
"bol_number": "string",
"buy_it_now_amount": 0.1,
"buy_it_now_amount_currency": "string",
"capacity_provider_customer_reference_number": "string",
"charge_line_items": [{"category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
"charge_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"unit_amount": 0.1,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"customer_reference_number": "string",
"drayage_container_return_date": "2019-08-24",
"drayage_estimated_arrival_date": "2019-08-24",
"drayage_last_free_date": "2019-08-24",
"drayage_release_date": "2019-08-24",
"equipment_type": {"id": 0,
"machine_readable": "string",
"name": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"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"
}
],
"max_buy_amount": 0.1,
"max_buy_amount_currency": "string",
"mode": {"code": "string",
"description": "string",
"id": 0
},
"notes_for_carrier": "string",
"pickup_number": "string",
"pro_number": "string",
"purchase_order_number": "string",
"service_level": {"code": "string",
"description": "string",
"id": 0
},
"shipment_name": "string",
"stops": [{"accessorials": [{"code": "string",
"currency_unit": "string",
"description": "string",
"id": 0,
"is_charge_code": true,
"long_description": "string",
"price": 0.1,
"type": "string"
}
],
"appointment_needed": true,
"appointment_type": {"code": "string",
"id": 0,
"name": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"instructions": "string",
"location": {"address": {"address_1": "string",
"address_2": "string",
"city": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"formatted_address": "string",
"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",
"location_name": "string",
"location_type": {"id": 0,
"name": "string"
},
"point_of_contacts": [{"created_at": null,
"email": null,
"first_name": null,
"full_name": null,
"job_title": null,
"last_name": null,
"phone_number": null,
"receive_bol_on_shipment_booked": null,
"updated_at": null
}
],
"updated_at": "2019-08-24T14:15:22Z"
},
"planned_date": "string",
"planned_time_window_end": "14:15:22Z",
"planned_time_window_start": "14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"target_rate_amount": 0.1,
"target_rate_amount_currency": "string",
"temperature_lower_limit": 0.1,
"temperature_upper_limit": 0.1,
"template_name": "string",
"total_declared_value": 0.1,
"total_declared_value_currency": "string",
"total_weight_override": {"unit": "KG",
"value": 0.1
},
"total_weight_override_unit": "LB",
"updated_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"
},
"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"
}
}
],
"total_count": 0,
"total_pages": 0
}