Jump to Content
byrd developer docs and guidesGuidesAPI ReferenceChangelog
HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceChangelogLog Inbyrd developer docs and guides
Log In

Getting Started

  • Integration Overview
  • Getting started with byrd APIs
    • Requesting a test account
    • Authentication
    • How to call the APIs
  • Receiving production access

PRODUCTS

  • Overview
  • Creating products
    • Creating a product
    • Creating a product bundle
  • Getting products stock and other details
    • Getting the details of a product
    • Listing products
    • Listing lots
    • Getting stock movements

DELIVERIES

  • Overview
  • Announcing a delivery
  • Getting the details of a delivery
  • Listing deliveries
  • Delivery note example

SHIPMENTS

  • Overview
  • Creating shipments
    • Creating a shipment
    • Creating a B2B shipment
    • Pickup points for DHL Germany
  • Releasing, recalling and modifying shipments
    • Releasing a shipment
    • Recalling a shipment
    • Updating a shipment
  • Getting unit data and other shipment details
    • Tracking data
    • Shipped serial numbers
    • Shipped items lot data
    • Getting the details of a shipment
    • Listing shipments
  • Template documents
    • How to create a template
    • Filtering different templates
    • Context variables
    • Formatting and formulas
    • Example templates

RETURNS

  • Overview
  • Listing returns

RESOURCES

  • Listing warehouses
  • Listing carriers
  • Listing B2B config templates
Powered by 

Overview

Suggest Edits

Deliveries need to be announced to the warehouse beforehand to make sure to allocate resources to store the items. A detailed information about delivery guidelines can be found here

Before starting to create shipments you need to announce the products you want to include in the shipments. Skipping this step can lead to errors in further steps.

Updated about 2 months ago