Jump to Content

Guides API Reference Changelog

Home Guides API Reference Changelog

v3.1

Guides API Reference Changelog Log In

API Reference

v3.1

All

Pages

Start typing to search…

API to access byrd systems

AuthAPIV2
- Get details of your own user.get
B2BConfigTemplateAPI
- Endpoint for returning a list of B2BConfigTemplate instances.get
LoginAPIV2
- Log in User into system.post
RefreshTokenAPI
- Prepare a new access token for a User.post
ShipmentExportAPI
- Get CSV Shipment Report.get
UserAPIV2
- Update user account's details.patch
DeliveriesAPI
- Create a new Delivery.post
- List Deliveries.get
DeliveryAPI
InventoryExportAPI
- Get CSV Inventory Report.get
LotDetailAPI
- Get details of a specific Lot.get
LotListAPI
- List Lotsget
ProductAPI
ProductsAPI
- Create a new Product.post
- List Products.get
ShipmentAPIV3
ShipmentBatchReleaseAPIV3
- Resource for scheduling shipments for release.post
ShipmentDocumentFileAPIV3
- /v3/shipments/{shipment_id}/documents/{document_id}/fileget
ShipmentDocumentsBatchAPIV3
- Upload document(s) for a shipment.post
- List endpoint for shipment documents.get
ShipmentListAPIV3
- Resource for creating a shipment.post
- List endpoint for V3 Shipments.get
ShipmentPickListAPIV3
- List endpoint for fetching a shipment's picks.get
ShipmentRecallAPIV3
- Resource for recalling a shipment and deleting its fulfillment.post
CarrierAPI
- Get available carrier options.get

Powered by

Upload document(s) for a shipment.

post

https://api.getbyrd.com/v3/shipments/{shipment_id}/documents

Language

Credentials

Bearer

JWT

Click Try It! to start a request and see the response here!