GuidesAPI ReferenceChangelog
API Reference

Resource for creating a shipment.

post
https://api.getbyrd.com/v3/shipments
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

Validate the request without creating the shipment

Body Params
customs
object | null
options
object
pickup_point
object | null
shop
object
string
string
cash_on_delivery
object | null
insurance
object | null
items
array of objects
required
length ≥ 1
items*
string | null
children
array of objects | null
children
customs
object | null
string | null
boolean | null
string | null
string | null
string | null
price
object | null
dimensions
object | null
string | null
string | null
int32
required
≥ 1
destination_address
object
required
notes
object | null
string
enum
Allowed:
documents
array of objects
documents
packaging_materials
array of objects
packaging_materials
Headers
string
enum
Defaults to application/vnd.byrd.customer+json

Generated from available request content types

Allowed:
Responses

Updated 8 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago