Banyan Technology Logistics Web Services v3

https://ws.logistics.banyantechnology.com/docs
Admin
Banyan Technology Logistics Web Services v3 provides APIs for integrating and managing logistics...
Tokens:1,467
Snippets:9
Trust Score:9.1
Update:10 months ago
Show doc for...
Tokens:
Raw
### Recommended Integration Workflow

Source: https://ws.logistics.banyantechnology.com/docs/index

The standard workflow for shipment management includes creating a shipment, optionally retrieving carrier quotes, booking the shipment, and retrieving tracking statuses. This sequence demonstrates the typical client interaction pattern with the API.

```APIDOC
## Shipment Integration Workflow

### Step 1: Authenticate
Obtain OAuth bearer token using Client Credentials flow with required scopes.

### Step 2: Create Shipment
Submit shipment details (origin, destination, items, dimensions).

### Step 3: Retrieve Carrier Quotes (Optional)
Request quotes from available carriers for the shipment route.

### Step 4: Book Shipment
Select carrier and confirm shipment booking.

### Step 5: Track Shipment
Retrieve tracking status and events for the booked shipment.

### Workflow Diagram
```
1. POST /auth/token
   └─> Get access_token

2. POST /shipments
   └─> Get shipment_id

3. GET /shipments/{shipment_id}/quotes
   └─> Get carrier options

4. POST /shipments/{shipment_id}/book
   └─> Get booking_confirmation

5. GET /shipments/{shipment_id}/tracking
   └─> Get tracking_status
```

### Implementation Notes
- All requests require valid Authorization header with bearer token
- Use path parameters for resource identification
- Query parameters available for filtering and pagination
- Handle multiple response codes (2xx success, 4xx client errors, 5xx server errors)
- Reference schema section for data types and field nullability
```

--------------------------------

### API Authentication Overview

Source: https://ws.logistics.banyantechnology.com/docs/index

Banyan Technology uses OAuth 2.0 authentication requiring a bearer token for all API requests. Clients must obtain credentials and use the token URL to acquire access tokens with appropriate scopes.

```APIDOC
## Authentication

### Description
OAuth 2.0 bearer token authentication is required for all API endpoints. Obtain credentials and retrieve a bearer token from the token URL before making requests.

### Method
POST

### Endpoint
[Token URL - See API Servers section]

### Parameters
#### Request Body
- **client_id** (string) - Required - Your OAuth client identifier
- **client_secret** (string) - Required - Your OAuth client secret
- **grant_type** (string) - Required - Use "client_credentials"
- **scope** (string) - Required - Space-separated list of required scopes

### Request Example
{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "grant_type": "client_credentials",
  "scope": "shipments invoices tracking"
}

### Response
#### Success Response (200)
- **access_token** (string) - Bearer token for API authentication
- **token_type** (string) - Token type (typically "Bearer")
- **expires_in** (integer) - Token expiration time in seconds

#### Response Example
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

### Usage
Include the bearer token in the Authorization header for all subsequent requests:
```
Authorization: Bearer {access_token}
```
```

--------------------------------

### API Endpoints Structure

Source: https://ws.logistics.banyantechnology.com/docs/index

Banyan Technology API v3 provides four main endpoint categories: Shipments for freight management, Invoices for billing data, Tracking for shipment status, and Static Data for reference information. Each endpoint includes path parameters, request/response schemas, and multiple HTTP status code responses.

```APIDOC
## Available Endpoint Categories

### Shipments Endpoints
Manage freight shipments including creation, carrier quotes, and booking.
- Create shipment
- Get carrier quotes
- Book shipment
- List shipments

### Invoices Endpoints
Retrieve and manage billing and invoice data.
- Get invoices
- Get invoice details
- Invoice line items

### Tracking Endpoints
Retrieve real-time tracking information for shipments.
- Get tracking status
- Track shipment events
- Track multiple shipments

### Static Data Endpoints
Access reference data and configuration information.
- Get carriers
- Get service types
- Get pickup locations
- Get delivery locations

### Standard Response Structure
#### Response Fields
- **data** (object/array) - Primary response data
- **status** (string) - Response status ("success", "error")
- **code** (integer) - HTTP status code
- **message** (string) - Human-readable message
- **timestamp** (string) - ISO 8601 timestamp

#### Response Example
{
  "status": "success",
  "code": 200,
  "data": {
    "id": "shipment_123",
    "carrier": "FedEx",
    "status": "booked"
  },
  "message": "Request completed successfully",
  "timestamp": "2024-01-15T10:30:00Z"
}
```
Tokens:
Raw