Beta
Not authenticated — log in first
VendorShipments

List Shipments

List Shipments — vendor REST API endpoint.

GET/vendor/shipmentsVendor bearer token required

List Shipments

List shipments for a vendor suborder.

What this means in plain English

Returns all shipments associated with a specific suborder ID for your vendor.

When to use this

  • Checking existing shipments before creating a new one.

Query parameters

NameTypeRequiredDescription
suborderIdstring (UUID)YesThe vendor suborder ID to list shipments for.

Request example

curl -X GET 'https://api.next.gcommerce.glass/api/v1/vendor/shipments?suborderId=550e8400-e29b-41d4-a716-446655440031'

Response examples

200Success
[{
  "id": "550e8400-e29b-41d4-a716-446655440040",
  "orderId": "550e8400-e29b-41d4-a716-446655440029",
  "suborderId": "550e8400-e29b-41d4-a716-446655440031",
  "shippingMethodId": "550e8400-e29b-41d4-a716-446655440060",
  "status": "SHIPPED",
  "trackingNumber": "1Z999AA10123456784",
  "carrier": "UPS",
  "trackingUrl": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
  "shippedAt": "2026-06-12T10:00:00.000Z",
  "deliveredAt": null,
  "shippingAddress": {
    "firstName": "John",
    "lastName": "Buyer",
    "address1": "456 Oak Ave",
    "city": "Dallas",
    "region": "TX",
    "postalCode": "75201",
    "country": "US"
  },
  "createdAt": "2026-06-11T14:00:00.000Z",
  "updatedAt": "2026-06-12T10:00:00.000Z",
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440041",
      "shipmentId": "550e8400-e29b-41d4-a716-446655440040",
      "orderItemId": "550e8400-e29b-41d4-a716-446655440032",
      "quantity": 2,
      "createdAt": "2026-06-11T14:00:00.000Z"
    }
  ],
  "shippingMethod": {
    "id": "550e8400-e29b-41d4-a716-446655440060",
    "name": "Standard Shipping"
  }
}]

Status codes

200

OK

Request succeeded.

401

Unauthorized

Missing or invalid bearer token.

403

Forbidden

Insufficient permissions for this action.

400

Bad Request

Validation failed or invalid parameters.

404

Not Found

Resource not found.

429

Too Many Requests

Global rate limit exceeded (10,000 requests per 10 minutes per IP).

500

Internal Server Error

Unexpected server error.

403

Forbidden

No vendor membership, or insufficient vendor role (requires OWNER, ADMIN, or EDITOR for write operations).

Try it

Uses your saved session from login. Edit values and send a live request, or copy the cURL command.