Module shipwire.receivings

ballerinax/shipwire.receivings Ballerina library

2.0.0

Overview

Shipwire is an order fulfillment and logistics platform that manages inventory across Shipwire and Shipwire Anywhere warehouses.

The Shipwire Receivings connector lets Ballerina applications manage receiving orders (advance ship notices) through version 3 of the Shipwire Receivings API. It supports creating, updating, listing, cancelling and completing receivings, and reading their items, holds, shipments, trackings, labels and instruction recipients.

Key features

  • Create and update advance ship notices for Shipwire and Shipwire Anywhere warehouses
  • List and retrieve receiving orders with optional filters and expanded data
  • Cancel receiving orders and receiving labels
  • Mark receivings as complete
  • Inspect receiving items, holds, shipments, trackings, labels and instruction recipients

Setup guide

To use the Shipwire Receivings connector you need a Shipwire account with API access.

  1. Sign in to your Shipwire account, or create one at shipwire.com.

  2. Make sure the account user you will authenticate with has permission to manage receivings.

  3. Note the username (email) and password of that user. The connector authenticates with HTTP basic authentication using these credentials.

Quickstart

To use the shipwire.receivings connector in your Ballerina application, update the .bal file as follows:

  1. Import the shipwire.receivings module.

    Copy
    import ballerinax/shipwire.receivings;
  2. Create a Config.toml file with your credentials.

    Copy
    username = "<Shipwire username>"
    password = "<Shipwire password>"
  3. Create a receivings:ConnectionConfig and initialize the client.

    Copy
    configurable string username = ?;
    configurable string password = ?;
    
    final receivings:Client shipwire = check new ({
        auth: {
            username,
            password
        }
    });
  4. Invoke the connector operation.

    Copy
    public function main() returns error? {
        receivings:ListReceivingsResponse _ = check shipwire->listReceivings();
    }

Examples

The Shipwire Receivings connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

  1. Receiving status report - Retrieve a receiving order together with its items and holds.
  2. Advance notice lifecycle - Create an advance ship notice and optionally cancel it.

Import

import ballerinax/shipwire.receivings;Copy

Other versions

See more...

Metadata

Released date: 1 day ago

Version: 2.0.0

License: Apache-2.0


Security

Direct vulnerabilities: No known direct vulnerabilities

Indirect vulnerabilities: 

Checked on 2026-11-21 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes


Pull count

Total: 42

Current verison: 1


Weekly downloads


Source repository


Keywords

Vendor/Shipwire

Area/ERP & Business Operations

Type/Connector


Contributors