ImportYeti bill-of-lading records API
Use the ImportYeti bill-of-lading records API to retrieve bill-of-lading records, trading parties and published shipment attributes. Select an importer or supplier slug or profile URL and filter partner country, description or date range; pagination returns the matching published bill-of-lading records. Inspect trading relationships, compare recorded shipment activity, or identify counterparties for a supply-chain investigation. Published customs records represent recorded shipments and counterparties, rather than a complete worldwide trade history or current stock availability. The detail page provides request and response examples, supported parameters, and usage pricing.
- Selected price
- $0.002 / billing creditPublished pricing
- Sellers / implementations
- 1 / 1
- Requests · 30d
- —Loading...
- Success rate · 30d
- —Loading...
| Seller | Pricing | Requests · 30d | Performance | Access |
|---|---|---|---|---|
apishCurrent ImportYeti bill-of-lading records API · GET · View API reference | $0.002 / billing credit | — | —successP50— |
Run sends a real API request. Charges follow the published API contract.
Response structure
cachedbooleancountintegercredits_usedintegerkindstringnamestringnext_pageintegernotestringpageintegershipments(object | string)[]bill_of_ladingstringbill_typestringconsigneeobjectnamestringurlstring
containersintegerdatestringdescriptionstringhouse_bill_of_ladingstringhs_codesnullmaster_bill_of_ladingstringport_of_loadingnullport_of_unloadingnullquantitystringquantity_unitstringshipperobjectaddressstringcitystringcountrystringcountry_codestringnamestringurlstring
shipping_cost_usdnullshipping_routestringweight_kginteger
sizeintegerslugstringtotalintegertotal_shipmentsintegerurlstring
// Inferred from response examples. Fields are optional and other fields may be returned.
export type ApiResponse = {
cached?: boolean;
count?: number;
credits_used?: number;
kind?: string;
name?: string;
next_page?: number;
note?: string;
page?: number;
shipments?: Array<{
bill_of_lading?: string;
bill_type?: string;
consignee?: {
name?: string;
url?: string;
};
containers?: number;
date?: string;
description?: string;
house_bill_of_lading?: string;
hs_codes?: null;
master_bill_of_lading?: string;
port_of_loading?: null;
port_of_unloading?: null;
quantity?: string;
quantity_unit?: string;
shipper?: {
address?: string;
city?: string;
country?: string;
country_code?: string;
name?: string;
url?: string;
};
shipping_cost_usd?: null;
shipping_route?: string;
weight_kg?: number;
} | string>;
size?: number;
slug?: string;
total?: number;
total_shipments?: number;
url?: string;
};- Method
- GET
- Endpoint
https://api.openany.si/v1/agent-apis/apish/importyeti/v1/shipments- Content type
- application/json
- Authentication
Authorization: Bearer $OPENANY_API_KEY
curl \
'https://api.openany.si/v1/agent-apis/apish/importyeti/v1/shipments?output=json&slug=nike-usa' \
-X GET \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json'Input parameters
Fields in this listing; additional options and input encoding can vary by provider.
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
slug | URL query parametersquery | string | No | Slug as in importyeti.com/company/<slug>, e.g. `nike-usa`. |
url | URL query parametersquery | string | No | An importyeti.com/company/<slug> or /supplier/<slug> link, instead of `slug`. |
type | URL query parametersquery | string | No | company (default) for an importer, supplier for a foreign supplier. enum: "company", "supplier" |
country | URL query parametersquery | string | No | Only records whose partner is in this country (name or 2-letter code). |
q | URL query parametersquery | string | No | Only records whose description or partner name contains these words. |
date_from | URL query parametersquery | string | No | Earliest shipment date, YYYY-MM-DD. |
date_to | URL query parametersquery | string | No | Latest shipment date, YYYY-MM-DD. |
size | URL query parametersquery | integer | No | Records per page (1-50, default 10). |
page | URL query parametersquery | integer | No | Page number. Pass `next_page` from the previous response. |
raw | URL query parametersquery | string | No | 0 leaves out the bulky `raw` source blocks (often 10-30x smaller). enum: "0", "1" |
fields | URL query parametersquery | string | No | Comma-separated fields to return, e.g. `posts.id,posts.title`. Call metadata is always included. |
fresh | URL query parametersquery | string | No | 1 skips the 24-hour cache and fetches live. enum: "1" |
output | URL query parametersquery | string | No | JSON only for this OpenAny product. Omit output or use json; CSV and NDJSON exports are not exposed. enum: "json" |
records | URL query parametersquery | string | No | Native CSV/NDJSON record selector; it has no effect on this JSON-only product. |
Required markers inside a nested object or variant apply when that object or variant is used.
Sample response
Sample response · Documented HTTP 200 Example from the provider's documentation. Field values in your results will differ.
{
"cached": false,
"count": 10,
"credits_used": 1,
"kind": "company",
"name": "Nike Usa",
"next_page": 2,
"note": "The most recent records shown on the public profile (up to 50).",
"page": 1,
"shipments": [
{
"bill_of_lading": "BANQ1077065409",
"bill_type": "H",
"consignee": {
"name": "Nike Usa",
"url": "https://www.importyeti.com/company/nike-usa"
},
"containers": 1,
"date": "2026-11-01",
"description": "Arranged Apparel Equipment Mens Womens Boys Girls Line Womens Knit Shorts Fabric Polyester Spandex Details Line Nbl Nbl Nbl Nsh Nbl Nmx Nmx …",
"house_bill_of_lading": "BANQ1077065409",
"hs_codes": null,
"master_bill_of_lading": "MEDUKL941300",
"port_of_loading": null,
"port_of_unloading": null,
"quantity": "683",
"quantity_unit": "CTN",
"shipper": {
"address": "Layden Bastian Road #08 3Rd Floor York Arcle Building Colombo 1 12500 Lk",
"city": "Colombo Division",
"country": "Sri Lanka",
"country_code": "LK",
"name": "Apl Logistics Ltd",
"url": "https://www.importyeti.com/supplier/apl-logistics-vietnam"
},
"shipping_cost_usd": null,
"shipping_route": "Asia,Transatlantic",
"weight_kg": 1938
},
{
"bill_of_lading": "BANQ1076734519",
"bill_type": "H",
"consignee": {
"name": "Nike Usa",
"url": "https://www.importyeti.com/company/nike-usa"
},
"containers": 1,
"date": "2026-11-01",
"description": "Ocm Ctp Arranged Apparel Equipment Mens Womens Boys Girls Line Womens Knit Shorts Fabric Polyester Spandex Details Line Nsh Nsh Scac Banq Hb…",
"house_bill_of_lading": "BANQ1076734519",
"hs_codes": null,
"master_bill_of_lading": "MEDUKL941300",
"port_of_loading": null,
"port_of_unloading": null,
"quantity": "80",
"quantity_unit": "CTN",
"shipper": {
"address": "Layden Bastian Road #08 3Rd Floor York Arcle Building Colombo 1 12500 Lk",
"city": "Colombo Division",
"country": "Sri Lanka",
"country_code": "LK",
"name": "Apl Logistics Ltd",
"url": "https://www.importyeti.com/supplier/apl-logistics-vietnam"
},
"shipping_cost_usd": null,
"shipping_route": "Asia,Transatlantic",
"weight_kg": 371
},
"… 8 more"
],
"size": 10,
"slug": "nike-usa",
"total": 50,
"total_shipments": 141097,
"url": "https://www.importyeti.com/company/nike-usa"
}Composite rule pricing
Calculated from input parameters and actual returned quantities. Estimate the maximum cost before calling.
Base fee: $0.000000. One matching variant replaces the base fee. Matching add-ons and quantity charges are added.
| Fee item | Price | Metering source | When | Quantity limit |
|---|---|---|---|---|
| Actual API.SH credits consumed | $0.002000 / billing credit | Response · /credits_used · Numeric value | Always | 1 billing credit · Decimal places: 0 |
Each quantity charge is rounded before summing: ceil. Requests exceeding this cost limit are rejected; it is not a price cap: $0.002000.
Response quantities settle after the response. Before execution, the maximum quantity determines the reservation; unused reservation is released. Missing or invalid quantities are not treated as zero.
Pricing parameters and defaults
[]
Agent integration
Copy the resource contract without sharing an API key.
View API Markdown
# ImportYeti bill-of-lading records API
Use the ImportYeti bill-of-lading records API to retrieve bill-of-lading records, trading parties and published shipment attributes. Select an importer or supplier slug or profile URL and filter partner country, description or date range; pagination returns the matching published bill-of-lading records. Inspect trading relationships, compare recorded shipment activity, or identify counterparties for a supply-chain investigation. Published customs records represent recorded shipments and counterparties, rather than a complete worldwide trade history or current stock availability. The detail page provides request and response examples, supported parameters, and usage pricing.
## Available implementations
apish · ImportYeti bill-of-lading records API: https://openany.si/markets/apis/capabilities/importyeti-bill-of-lading-records-api?offering=2d7ab5e1-edd6-4435-8dcb-5ad6fa048cac · $0.002 / billing credit
## Selected API contract
Documentation: https://openany.si/markets/apis/capabilities/importyeti-bill-of-lading-records-api
Method: GET
Endpoint: https://api.openany.si/v1/agent-apis/apish/importyeti/v1/shipments
Price: $0.002 / billing credit
Provider: apish
Contract revision: 2
Price source: OpenAny public API contract and documented provider unit rates. Price update time: not supplied.
Use OPENANY_API_KEY from the environment. API Key calls use your shared balance.
## Prepared request
```bash
curl \
'https://api.openany.si/v1/agent-apis/apish/importyeti/v1/shipments?output=json&slug=nike-usa' \
-X GET \
-H "Authorization: Bearer $OPENANY_API_KEY" \
-H 'Content-Type: application/json'
```
## API contract
```json
{
"resource_type": "api",
"name": "ImportYeti bill-of-lading records API",
"endpoint": "https://api.openany.si/v1/agent-apis/apish/importyeti/v1/shipments",
"method": "GET",
"content_type": "none",
"execution_mode": "sync",
"authentication": {
"type": "bearer",
"environment_variable": "OPENANY_API_KEY"
},
"inputs": [
{
"description": "Slug as in importyeti.com/company/<slug>, e.g. `nike-usa`.",
"location": "query",
"name": "slug",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "An importyeti.com/company/<slug> or /supplier/<slug> link, instead of `slug`.",
"location": "query",
"name": "url",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "company (default) for an importer, supplier for a foreign supplier.",
"enum_values": [
"company",
"supplier"
],
"location": "query",
"name": "type",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Only records whose partner is in this country (name or 2-letter code).",
"location": "query",
"name": "country",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Only records whose description or partner name contains these words.",
"location": "query",
"name": "q",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Earliest shipment date, YYYY-MM-DD.",
"location": "query",
"name": "date_from",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Latest shipment date, YYYY-MM-DD.",
"location": "query",
"name": "date_to",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Records per page (1-50, default 10).",
"location": "query",
"name": "size",
"nullable": false,
"required": false,
"type": "integer"
},
{
"description": "Page number. Pass `next_page` from the previous response.",
"location": "query",
"name": "page",
"nullable": false,
"required": false,
"type": "integer"
},
{
"description": "0 leaves out the bulky `raw` source blocks (often 10-30x smaller).",
"enum_values": [
"0",
"1"
],
"location": "query",
"name": "raw",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Comma-separated fields to return, e.g. `posts.id,posts.title`. Call metadata is always included.",
"location": "query",
"name": "fields",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "1 skips the 24-hour cache and fetches live.",
"enum_values": [
"1"
],
"location": "query",
"name": "fresh",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "JSON only for this OpenAny product. Omit output or use json; CSV and NDJSON exports are not exposed.",
"enum_values": [
"json"
],
"location": "query",
"name": "output",
"nullable": false,
"required": false,
"type": "string"
},
{
"description": "Native CSV/NDJSON record selector; it has no effect on this JSON-only product.",
"location": "query",
"name": "records",
"nullable": false,
"required": false,
"type": "string"
}
],
"billing": {
"currency": "USD",
"mode": "rules",
"parameters": [],
"policy_version": 2,
"sale": {
"addons": [],
"base_price_micro_usd": "0",
"max_cost_micro_usd": "2000",
"quantities": [
{
"id": "upstream_credits",
"label": "Actual API.SH credits consumed",
"max_quantity": "1",
"measure": "value",
"pointer": "/credits_used",
"price_micro_usd": "2000",
"quantity_scale": 0,
"source": "response",
"unit": "credit",
"unit_quantity": "1"
}
],
"rounding": "ceil",
"variants": []
}
},
"examples": [
{
"http_status": 200,
"name": "Official example · Official documentation response · Supplier-tr",
"request": {
"body": null,
"headers": {},
"path": {},
"query": {
"output": "json",
"slug": "nike-usa"
}
},
"response_body": {
"cached": false,
"count": 10,
"credits_used": 1,
"kind": "company",
"name": "Nike Usa",
"next_page": 2,
"note": "The most recent records shown on the public profile (up to 50).",
"page": 1,
"shipments": [
{
"bill_of_lading": "BANQ1077065409",
"bill_type": "H",
"consignee": {
"name": "Nike Usa",
"url": "https://www.importyeti.com/company/nike-usa"
},
"containers": 1,
"date": "2026-11-01",
"description": "Arranged Apparel Equipment Mens Womens Boys Girls Line Womens Knit Shorts Fabric Polyester Spandex Details Line Nbl Nbl Nbl Nsh Nbl Nmx Nmx …",
"house_bill_of_lading": "BANQ1077065409",
"hs_codes": null,
"master_bill_of_lading": "MEDUKL941300",
"port_of_loading": null,
"port_of_unloading": null,
"quantity": "683",
"quantity_unit": "CTN",
"shipper": {
"address": "Layden Bastian Road #08 3Rd Floor York Arcle Building Colombo 1 12500 Lk",
"city": "Colombo Division",
"country": "Sri Lanka",
"country_code": "LK",
"name": "Apl Logistics Ltd",
"url": "https://www.importyeti.com/supplier/apl-logistics-vietnam"
},
"shipping_cost_usd": null,
"shipping_route": "Asia,Transatlantic",
"weight_kg": 1938
},
{
"bill_of_lading": "BANQ1076734519",
"bill_type": "H",
"consignee": {
"name": "Nike Usa",
"url": "https://www.importyeti.com/company/nike-usa"
},
"containers": 1,
"date": "2026-11-01",
"description": "Ocm Ctp Arranged Apparel Equipment Mens Womens Boys Girls Line Womens Knit Shorts Fabric Polyester Spandex Details Line Nsh Nsh Scac Banq Hb…",
"house_bill_of_lading": "BANQ1076734519",
"hs_codes": null,
"master_bill_of_lading": "MEDUKL941300",
"port_of_loading": null,
"port_of_unloading": null,
"quantity": "80",
"quantity_unit": "CTN",
"shipper": {
"address": "Layden Bastian Road #08 3Rd Floor York Arcle Building Colombo 1 12500 Lk",
"city": "Colombo Division",
"country": "Sri Lanka",
"country_code": "LK",
"name": "Apl Logistics Ltd",
"url": "https://www.importyeti.com/supplier/apl-logistics-vietnam"
},
"shipping_cost_usd": null,
"shipping_route": "Asia,Transatlantic",
"weight_kg": 371
},
"… 8 more"
],
"size": 10,
"slug": "nike-usa",
"total": 50,
"total_shipments": 141097,
"url": "https://www.importyeti.com/company/nike-usa"
}
}
]
}
```Error handling
| Status | Next step |
|---|---|
400 | Check the offering and request fields. |
401 / 403 | Verify your credentials and access permissions. |
402 | Inspect the selected access mode and returned payment requirements. |
429 | Respect the returned rate limit and retry guidance. |
5xx | Inspect the error and usage record before retrying a paid operation. |
Official example · Official documentation response · Supplier-tr
Example from the provider's documentation. Field values in your results will differ.
Prepare your environment
Use a terminal with cURL installed.
Use an OpenAny API key with shared-balance access. Confirm availability and price before running; a call may charge your balance.
Set the key in your terminal using the hidden prompt below. Keep its value out of source files and logs.
Terminal · macOS / Linuxprintf 'OpenAny API key: ' read -r -s OPENANY_API_KEY export OPENANY_API_KEY printf '\n'Run the request
Paste the complete command below into your terminal.
Values to replace before running 14
Review these request fields before running. Keep the published provider and request method unchanged.
slug- Slug as in importyeti.com/company/<slug>, e.g. `nike-usa`.
url- An importyeti.com/company/<slug> or /supplier/<slug> link, instead of `slug`.
type- company (default) for an importer, supplier for a foreign supplier.
country- Only records whose partner is in this country (name or 2-letter code).
q- Only records whose description or partner name contains these words.
date_from- Earliest shipment date, YYYY-MM-DD.
date_to- Latest shipment date, YYYY-MM-DD.
size- Records per page (1-50, default 10).
page- Page number. Pass `next_page` from the previous response.
raw- 0 leaves out the bulky `raw` source blocks (often 10-30x smaller).
fields- Comma-separated fields to return, e.g. `posts.id,posts.title`. Call metadata is always included.
fresh- 1 skips the 24-hour cache and fetches live.
output- JSON only for this OpenAny product. Omit output or use json; CSV and NDJSON exports are not exposed.
records- Native CSV/NDJSON record selector; it has no effect on this JSON-only product.
Terminal · cURLcurl \ 'https://api.openany.si/v1/agent-apis/apish/importyeti/v1/shipments?output=json&slug=nike-usa' \ -X GET \ -H "Authorization: Bearer $OPENANY_API_KEY" \ -H 'Content-Type: application/json'Check the response
Sample response · Documented HTTP 200
Sample response{ "cached": false, "count": 10, "credits_used": 1, "kind": "company", "name": "Nike Usa", "next_page": 2, "note": "The most recent records shown on the public profile (up to 50).", "page": 1, "shipments": [ { "bill_of_lading": "BANQ1077065409", "bill_type": "H", "consignee": { "name": "Nike Usa", "url": "https://www.importyeti.com/company/nike-usa" }, "containers": 1, "date": "2026-11-01", "description": "Arranged Apparel Equipment Mens Womens Boys Girls Line Womens Knit Shorts Fabric Polyester Spandex Details Line Nbl Nbl Nbl Nsh Nbl Nmx Nmx …", "house_bill_of_lading": "BANQ1077065409", "hs_codes": null, "master_bill_of_lading": "MEDUKL941300", "port_of_loading": null, "port_of_unloading": null, "quantity": "683", "quantity_unit": "CTN", "shipper": { "address": "Layden Bastian Road #08 3Rd Floor York Arcle Building Colombo 1 12500 Lk", "city": "Colombo Division", "country": "Sri Lanka", "country_code": "LK", "name": "Apl Logistics Ltd", "url": "https://www.importyeti.com/supplier/apl-logistics-vietnam" }, "shipping_cost_usd": null, "shipping_route": "Asia,Transatlantic", "weight_kg": 1938 }, { "bill_of_lading": "BANQ1076734519", "bill_type": "H", "consignee": { "name": "Nike Usa", "url": "https://www.importyeti.com/company/nike-usa" }, "containers": 1, "date": "2026-11-01", "description": "Ocm Ctp Arranged Apparel Equipment Mens Womens Boys Girls Line Womens Knit Shorts Fabric Polyester Spandex Details Line Nsh Nsh Scac Banq Hb…", "house_bill_of_lading": "BANQ1076734519", "hs_codes": null, "master_bill_of_lading": "MEDUKL941300", "port_of_loading": null, "port_of_unloading": null, "quantity": "80", "quantity_unit": "CTN", "shipper": { "address": "Layden Bastian Road #08 3Rd Floor York Arcle Building Colombo 1 12500 Lk", "city": "Colombo Division", "country": "Sri Lanka", "country_code": "LK", "name": "Apl Logistics Ltd", "url": "https://www.importyeti.com/supplier/apl-logistics-vietnam" }, "shipping_cost_usd": null, "shipping_route": "Asia,Transatlantic", "weight_kg": 371 }, "… 8 more" ], "size": 10, "slug": "nike-usa", "total": 50, "total_shipments": 141097, "url": "https://www.importyeti.com/company/nike-usa" }
Common questions
Do I need a separate key for every provider?
Use your OpenAny API key for standard API access. Read it from OPENANY_API_KEY in your environment and keep it out of prompts, source code and logs.
Are these providers interchangeable?
No. Each offering has its own inputs, pricing and response contract. Selecting a catalog offering does not establish automatic routing or fallback. Confirm the service contract before calling.
How is this API billed?
API-key calls use your shared balance at the selected implementation's published rate. Check the billing unit and request-specific pricing rules before making a paid call. Recorded usage determines the final charge under that contract.
Where do the price and contract come from?
The selected implementation publishes its provider, request contract, revision and billing rules through OpenAny's public API catalog. A revision number identifies a contract version, not a price update date. A price update timestamp is not supplied; do not treat a page date as one.
How do OpenAny Balance and x402 differ?
OpenAny Balance uses an API key and one shared balance. Card, USDC and x402 top-ups, card auto top-up and USDC subscriptions fund that balance; available routes appear on the Credits page. Direct x402 is a separate pay-per-request flow, available only on listings that show it and requiring an authorized payment client.
Does Playground send a paid request?
Yes. After you sign in, Run sends a real API request using an active OpenAny API key. Charges follow the published API contract and use your shared balance. Selecting an implementation, editing inputs and viewing sample responses do not send requests.
Use ImportYeti bill-of-lading records API with your agent
Inspect endpoint contracts and confirm availability and pricing before a paid call.