🛒

shippings

Shipping and delivery information for an order. Tracks shipping carrier, tracking number, delivery address, shipment date, estimated delivery, and shipping status.

🎯 Request Builder

https://api.mockly.codes/shippings?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/shippings

Get a collection of shippings

Alternative: /commerce/shippings
GET/shippings/:id

Get a single shipping by ID

Alternative: /commerce/shippings/:id
GET/shippings/meta

Get resource metadata and schema

Alternative: /commerce/shippings/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/shippings?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/shippings?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 shippings
fetch('https://api.mockly.codes/shippings?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/shippings?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/shippings?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/shippings?nocache=true')

Schema Properties

idinteger

Unique identifier for the shipping record

Gen:random_int
order_idinteger

Foreign key reference to the order being shipped

Gen:random_int
tracking_numberstring

Unique tracking number provided by the shipping carrier for package tracking

Gen:uuid
carrierstring

Shipping carrier or logistics company (e.g., FedEx, UPS, DHL, USPS)

Gen:company
statusstring

Current shipping status (e.g., pending, shipped, in_transit, out_for_delivery, delivered, failed)

Gen:status
shipped_datestring

Date when the order was shipped and left the warehouse

Gen:past_datedate
estimated_deliverystring

Expected delivery date provided by the shipping carrier

Gen:future_datedate
addressstring

Complete delivery address where the package is being shipped

Gen:address

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request