Orchestro

API Reference

Shipper

WMS RSE

Origin Carrier

Analytics

Corporate Website

This endpoint allows users to create a new shipment order with parcel and account details.


Create shipment orders

Address details for either the shipper or recipient.

Address type, either Business (B) or Residential (R).

Company name associated with the shipment address.

Country code, following the ISO 3166-1 alpha-2 standard.

Name of the person or department receiving the parcel.

Service attribute code indicating special delivery options.

Charge applied for the service attribute.

BearerAuth

Welcome to the Orchestro documentation guide. This guide will help you get started with Orchestro, a network that connects regional carriers to provide national-level shipping solutions.

Introduction

Carrier

Account Setup

Orchestro Network Standards

Data Flow

Network Service Types

Network Codes

List of Supported Network Service Attributes

Network Service Attributes

Errors and Warnings

Integration Protocol

Overview

Middle Mile Carrier

Last Mile Carrier

SFTP

Webhook

This section details the Orchestro standard label design format and specifications for its use.

Label Specification

Standard Manifest Format

Standard Event Format

This section detail all the fields in the Orchestro standardized [carrier invoice template](/dev/invoice/carrier/carrier-invoice-template).

Carrier Invoice

Carrier Invoice Template

Carrier Invoice Sample

This section detail all the fields in the Orchestro standardized [shipper invoice template](/dev/invoice/shipper-invoice-template).

Shipper Invoice

Shipper Invoice Template

Shipper Invoice Sample

Portal

Data Analytics

This section contains definition of terms

Glossary

Version 2.3.1(Current)

Version 2.2

Version 2.1

Version 2.0

Quick Start

 Orchestro API Features

Usecase

Authorization

Error Handling

This endpoint is used for recording and updating the status of shipping or transportation events.

PostTheEvents

This endpoint allows you to submit rate requests for various parcels by providing detailed shipment, account, and service information. It returns rate data for the shipment based on the provided attributes.

Rates

This endpoint allows users to create shipping labels by sending account information, parcel details, and shipment specifics. It returns the generated label or an error if the request fails.

Labels

This endpoint allows users to reprint shipping labels by providing account details, caller type, and label information. It returns the label ID or any errors encountered during the process.

Reprint-label

This endpoint allows users to cancel shipping labels by sending account details, caller type, and the label ID. It returns the cancellation status or relevant errors if the label was already canceled.

Cancel-label

This endpoint allows users to retrieve coverage information by providing an account number and service type (e.g., GRD). It returns a list of ZIP codes where the service is available for the specified service type.

Coverage-API

This endpoint captures event scan details for parcels as they move through the network.

Analytics

Create shipment orders

Authorizations

Headers

Body

Response