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
Array
Array of objects or null (Accessorial)
additional_bol_recipients
Array of strings or null
object (BillToOverride)

Collection of bill-to information that will render on Shipment documents

bol_number
string or null
buy_it_now_amount
number or null <float>
Array of objects or null (ShipmentChargeLineItemTemplate)
created_at
string or null <date-time>
object (ShipmentCustomData)

Custom data for Shipment

customer_reference_number
string or null
object (EquipmentType)

Equipment type

id
string or null <uuid>
Array of objects or null (ShipmentLineItem)
max_buy_amount
number or null <float>
object (ShipmentMode)

Standardized code for a shipment mode

notes_for_carrier
string or null
pickup_number
string or null
pro_number
string or null
purchase_order_number
string or null
object (ServiceLevel)

Standardized code for a shipment service level

shipment_name
string or null
Array of objects or null (ShipmentStopTemplate)
tags
Array of strings <uuid>
target_rate_amount
number or null <float>
template_name
required
string
total_declared_value
number or null <float>
object (TotalWeightOverride)
updated_at
string or null <date-time>
object (SlimCompany)
object (SlimCompany)
default

Default error response

get/shipments/templates/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Copyright © Shipwell 2024. All right reserved.