Crate shipbob

source · [−]
Expand description

A fully generated, opinionated API client library for ShipBob.

docs.rs

API Details

ShipBob Developer API Documentation

Authentication

Client Details

This client is generated from the ShipBob OpenAPI specs based on API spec version 1.0. This way it will remain up to date as features are added. The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
shipbob = "0.1.4"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use shipbob::Client;

let shipbob = Client::new(
    String::from("api-key"),
);

Alternatively, the library can search for most of the variables required for the client in the environment:

  • SHIPBOB_API_KEY

And then you can create a client from the environment.

use shipbob::Client;

let shipbob = Client::new_from_env();

Modules

channels

Use the Channel Resource to list “channels” which you have access to. You will use this channelId for subsequent API calls made to ShipBob endpoints.

inventory

Use the Inventory Resource to retrieve ShipBob inventory items and quantities.

locations

Use this API to interact with the physical locations across ShipBob’s fulfillment network.

orders

Note: The orderId in the API response will not match the Id displayed in the ShipBob Merchant Portal when you navigate to the Orders page. ShipBob is currently undergoing a schema migration and the Id displayed in the ShipBob Merchant Portal is the shipmentId not the orderId. In the future, the portal will display both orderId(s) and shipmentId(s).

products

Use the Products Resource to retrieve and create product records in ShipBob.

receiving

Use the Receiving Resource to retrieve, create and cancel Warehouse Receiving Orders (WROs).

returns

While the Returns API is live, ShipBob’s end to end Returns process will not go live until the beginning of March. As a result, any returns arriving at ShipBob’s fulfillment centers prior to March 12st, 2020 will NOT be processed.

types

The data types sent to and returned from the API client.

webhooks

Use the Webhooks Resource to create, view or delete subscriptions for a user.

Structs

Client

Entrypoint for interacting with the API client.

Constants

DEFAULT_HOST