Welcome to the Pattern Public API. This API allows you to manage your 3PL business with Pattern. The sections below provide information on the tasks you can perform via the Pattern Public API.
Note: You can use the API Explorer at developer.pattern.com to test your API calls.
To start using the API, you’ll first need to get your OAuth2 token.
Note: We have upgraded our authentication system. If you were already using authentication, you will eventually require the utilization of new client_id and client_secret credentials. While Pattern strongly suggests reauthentication as soon as possible, your existing credentials will not be disabled in the near term. Pattern plans to deprecate existing API credentials on September 30, 2026. You’ll receive more communication on this as that date gets closer.
To use OAuth2, complete the following steps:
- To get your client_id and secret, open Pattern Hub, then click Settings > API Credentials. Under API Credentials, select your organization to view your API credentials.
- Return to developer.pattern.com.
- On the Introduction page, select Public API or Staging API. You’ll see the URLs for each environment under the Server section:
- The base URL for staging is https://stage-api.pattern.com/hub
- The base URL for production is https://api.pattern.com/hub.
- In the Authentication section, you’ll find instructions for how to enter your token. All API endpoints require a Bearer token in the Authorization header.
- If you are ready to migrate from the old API to the new one, follow the instructions here.
DTC:
Pattern DTC Fulfillment is our direct-to-consumer solution where we handle the entire order process for your brand. You ship your products to Pattern, and we pick, prep, and pack each order, matching every shipment with the best carrier options for speed and cost. We offer order customization as needed and ship directly to your customers using the fastest turnaround and most competitive rates.
You can use the DTC endpoints to:
- Create DTC customer orders
- Retrieve order tracking information
- See current order status
- Cancel an order
Middle Mile:
Pattern Middle Mile answers the seller's dilemma about Amazon's inbound placement fees: do you pay Amazon a hefty fee to send FBA orders into one Amazon fulfillment center or do you increase shipping costs by splitting shipments to many fulfillment centers? Middle Mile provides a simpler solution: send your orders into Pattern's 3PL warehouses with optimized pricing, and we'll take it from there. It's a faster, lower-cost solution that removes the complexity from the equation.
You can use the Middle Mile endpoints to:
- Retrieve recent Middle Mile orders
- Create Middle Mile shipments
- Calculate shipment rates across warehouses before placing orders
Marketplace Prep:
Pattern accelerates brands on global marketplaces with technology, data, and logistics. Our FBA prep center is at the heart of this: prepping, packing, and shipping your inventory efficiently, staying ahead of compliance.
You can use the Marketplace Prep endpoints to:
- List all inventory requests (IRs)
- Retrieve IR details, including shipment ID, status, items received, estimated ship date, and warehouse
- Create a new IR
- Perform listing eligibility checks after you create an IR
- View all existing listing eligibility checks
- Get full marketplace shipment tracking information
- Retrieve marketplace work orders from storage
- Create a marketplace work order from storage
Inventory actions (applies across all products):
These end points can be used no matter which Fulfillment product you are using:
- Pull available inventory
- See inventory adjustments
- See inventory receipts
For warehouse actions (applies across all products):
These end points can be used no matter which Fulfillment product you are using:
- List available warehouses
Catalog (applies across all products):
Retrieve a list of your organization’s catalog items and catalog listings in order to understand your SKUs, bundles, and listings.