catalogapi-com · Schema

OrderTrackResponse

Response containing order tracking information

CompanyAPIRewardsGiftCardsGlobal

Properties

Name Type Description
order object
success boolean Whether the request was successful
timestamp string Response timestamp
View JSON Schema on GitHub

JSON Schema

catalogapi-com-order-track-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/catalogapi-com/json-schema/catalogapi-com-order-track-response-schema.json",
  "title": "OrderTrackResponse",
  "description": "Response containing order tracking information",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/catalogapi-com-openapi.yml#/components/schemas/OrderTrackResponse",
  "properties": {
    "order": {
      "$ref": "#/$defs/Order"
    },
    "success": {
      "description": "Whether the request was successful",
      "type": "boolean"
    },
    "timestamp": {
      "description": "Response timestamp",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "success",
    "timestamp",
    "order"
  ],
  "type": "object",
  "$defs": {
    "Order": {
      "description": "Order with line items and fulfillment information",
      "properties": {
        "address_1": {
          "description": "Address line 1",
          "type": "string"
        },
        "address_2": {
          "description": "Address line 2",
          "type": [
            "string",
            "null"
          ]
        },
        "address_3": {
          "description": "Address line 3",
          "type": [
            "string",
            "null"
          ]
        },
        "address_4": {
          "description": "Address line 4",
          "type": [
            "string",
            "null"
          ]
        },
        "city": {
          "description": "City",
          "type": "string"
        },
        "country": {
          "description": "Country code",
          "type": "string"
        },
        "created": {
          "description": "Order creation time",
          "format": "date-time",
          "type": "string"
        },
        "email": {
          "description": "Recipient email",
          "type": "string"
        },
        "external_order_id": {
          "description": "Your order reference",
          "type": "string"
        },
        "external_user_id": {
          "description": "User reference",
          "type": "string"
        },
        "fulfillments": {
          "description": "Fulfillment information",
          "items": {
            "$ref": "#/$defs/OrderFulfillment"
          },
          "type": "array"
        },
        "given_name": {
          "description": "Recipient's first name",
          "type": "string"
        },
        "is_test": {
          "description": "Test order flag",
          "type": "boolean"
        },
        "line_items": {
          "description": "Order line items",
          "items": {
            "$ref": "#/$defs/OrderLineItem"
          },
          "type": "array"
        },
        "order_number": {
          "description": "Internal order number",
          "type": "string"
        },
        "phone_number": {
          "description": "Recipient phone",
          "type": "string"
        },
        "postal_code": {
          "description": "Postal/zip code",
          "type": "string"
        },
        "socket_id": {
          "description": "Socket/catalog ID",
          "type": "integer"
        },
        "state_or_region": {
          "description": "State or region",
          "type": "string"
        },
        "surname": {
          "description": "Recipient's last name",
          "type": "string"
        },
        "updated": {
          "description": "Last update time",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "order_number",
        "external_order_id",
        "socket_id",
        "external_user_id",
        "created",
        "updated",
        "given_name",
        "surname",
        "address_1",
        "address_2",
        "address_3",
        "address_4",
        "city",
        "state_or_region",
        "postal_code",
        "country",
        "email",
        "phone_number",
        "is_test",
        "line_items",
        "fulfillments"
      ],
      "title": "Order",
      "type": "object"
    },
    "OrderFulfillment": {
      "description": "Fulfillment information for order line items",
      "properties": {
        "created_at": {
          "description": "Creation time",
          "format": "date-time",
          "type": "string"
        },
        "fulfillment_id": {
          "description": "Fulfillment ID",
          "type": "string"
        },
        "fulfillment_instructions": {
          "description": "Special instructions",
          "type": [
            "string",
            "null"
          ]
        },
        "fulfillment_type": {
          "description": "Type of fulfillment",
          "enum": [
            "physical",
            "digital"
          ],
          "type": "string"
        },
        "line_item_ids": {
          "description": "Associated line item IDs (UUIDs)",
          "items": {
            "description": "UUID of the line item",
            "format": "uuid",
            "type": "string"
          },
          "type": "array"
        },
        "shipper": {
          "description": "Shipping carrier",
          "type": [
            "string",
            "null"
          ]
        },
        "tracking_number": {
          "description": "Tracking number",
          "type": [
            "string",
            "null"
          ]
        },
        "updated_at": {
          "description": "Last update time",
          "format": "date-time",
          "type": "string"
        },
        "virtual_code_link": {
          "description": "Link for virtual codes",
          "type": [
            "string",
            "null"
          ]
        },
        "virtual_code_pin": {
          "description": "PIN for virtual codes",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "fulfillment_id",
        "line_item_ids",
        "fulfillment_type",
        "shipper",
        "tracking_number",
        "fulfillment_instructions",
        "virtual_code_link",
        "virtual_code_pin",
        "created_at",
        "updated_at"
      ],
      "title": "OrderFulfillment",
      "type": "object"
    },
    "OrderLineItem": {
      "description": "Line item within an order",
      "properties": {
        "price_paid": {
          "description": "Amount paid",
          "format": "decimal",
          "type": "string"
        },
        "category_ids": {
          "description": "Category IDs",
          "items": {
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "shipping_estimate": {
          "description": "Shipping estimate",
          "format": "decimal",
          "type": [
            "string",
            "null"
          ]
        },
        "is_primary": {
          "description": "Is primary item",
          "type": [
            "boolean",
            "null"
          ]
        },
        "original_points": {
          "description": "Original points",
          "type": [
            "integer",
            "null"
          ]
        },
        "updated_at": {
          "description": "Last update time",
          "format": "date-time",
          "type": "string"
        },
        "stock_reserved_until": {
          "description": "When the stock reservation expires",
          "format": "datetime",
          "type": [
            "string",
            "null"
          ]
        },
        "errors": {
          "description": "Any errors for this line item",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "price": {
          "description": "Item price",
          "format": "decimal",
          "type": "string"
        },
        "item_type_id": {
          "description": "Item type ID",
          "type": [
            "integer",
            "null"
          ]
        },
        "rank": {
          "description": "Display rank",
          "type": [
            "integer",
            "null"
          ]
        },
        "description": {
          "description": "Item description",
          "type": [
            "string",
            "null"
          ]
        },
        "catalog_item_id": {
          "description": "Catalog item ID",
          "type": "integer"
        },
        "supplier_reference_id": {
          "description": "Supplier reference",
          "type": [
            "string",
            "null"
          ]
        },
        "images": {
          "description": "Product images",
          "items": {
            "properties": {
              "alt": {
                "type": "string"
              },
              "is_primary": {
                "type": "boolean"
              },
              "order": {
                "type": "integer"
              },
              "urls": {
                "additionalProperties": {
                  "type": "string"
                },
                "type": "object"
              }
            },
            "type": "object"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "created_at": {
          "description": "Creation time",
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "description": "Item fulfillment status",
          "enum": [
            "new",
            "pending",
            "exported",
            "fulfilled",
            "cancelled",
            "backordered",
            "rejected"
          ],
          "type": "string"
        },
        "name": {
          "description": "Item name",
          "type": [
            "string",
            "null"
          ]
        },
        "product_id": {
          "description": "Product ID",
          "type": [
            "string",
            "null"
          ]
        },
        "retail_price": {
          "description": "Retail price",
          "format": "decimal",
          "type": [
            "string",
            "null"
          ]
        },
        "fulfillment_type": {
          "description": "Fulfillment type",
          "type": [
            "string",
            "null"
          ]
        },
        "is_available": {
          "description": "Is available",
          "type": [
            "boolean",
            "null"
          ]
        },
        "is_explicit": {
          "description": "Has explicit content",
          "type": [
            "boolean",
            "null"
          ]
        },
        "is_limited_stock": {
          "description": "Limited stock flag",
          "type": [
            "boolean",
            "null"
          ]
        },
        "brand_id": {
          "description": "Brand ID",
          "type": [
            "integer",
            "null"
          ]
        },
        "availability": {
          "description": "Availability status",
          "type": [
            "string",
            "null"
          ]
        },
        "original_price": {
          "description": "Original price",
          "format": "decimal",
          "type": [
            "string",
            "null"
          ]
        },
        "line_item_id": {
          "description": "Line item ID",
          "type": "string"
        },
        "model": {
          "description": "Model/SKU",
          "type": [
            "string",
            "null"
          ]
        },
        "product_options": {
          "additionalProperties": true,
          "description": "Available product options",
          "type": [
            "object",
            "null"
          ]
        },
        "supplier_id": {
          "description": "Supplier ID",
          "type": [
            "integer",
            "null"
          ]
        },
        "metadata": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Additional metadata",
          "type": [
            "object",
            "null"
          ]
        },
        "options": {
          "description": "Selected product options with translations",
          "items": {
            "properties": {
              "order": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              },
              "translations": {
                "items": {
                  "properties": {
                    "language": {
                      "type": "string"
                    },
                    "option_name": {
                      "type": "string"
                    },
                    "value_name": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                },
                "type": "array"
              },
              "value": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "required_fields": {
          "additionalProperties": {
            "type": "boolean"
          },
          "description": "Required fields for ordering",
          "type": [
            "object",
            "null"
          ]
        },
        "is_taxable": {
          "description": "Is taxable",
          "type": [
            "boolean",
            "null"
          ]
        },
        "brand": {
          "description": "Brand name",
          "type": [
            "string",
            "null"
          ]
        },
        "shipping_paid": {
          "description": "Shipping paid",
          "format": "decimal",
          "type": [
            "string",
            "null"
          ]
        },
        "points_paid": {
          "description": "Points paid",
          "type": [
            "integer",
            "null"
          ]
        },
        "tag_ids": {
          "description": "Tag IDs",
          "items": {
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "is_stock_reserved": {
          "description": "Whether stock is reserved for this item",
          "type": [
            "boolean",
            "null"
          ]
        },
        "tax_paid": {
          "description": "Tax paid",
          "format": "decimal",
          "type": [
            "string",
            "null"
          ]
        },
        "points": {
          "description": "Points value",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "line_item_id",
        "metadata",
        "errors",
        "stock_reserved_until",
        "is_stock_reserved",
        "options",
        "catalog_item_id",
        "product_id",
        "name",
        "description",
        "brand",
        "brand_id",
        "model",
        "category_ids",
        "tag_ids",
        "item_type_id",
        "supplier_id",
        "supplier_reference_id",
        "availability",
        "is_available",
        "is_primary",
        "is_limited_stock",
        "is_taxable",
        "is_explicit",
        "fulfillment_type",
        "price",
        "original_price",
        "points",
        "original_points",
        "retail_price",
        "shipping_estimate",
        "rank",
        "images",
        "product_options",
        "required_fields",
        "price_paid",
        "points_paid",
        "tax_paid",
        "shipping_paid",
        "status",
        "created_at",
        "updated_at"
      ],
      "title": "OrderLineItem",
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/catalogapi-com-order-track-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.