Ordoro · Schema

Product Schema

Order ManagementInventory ManagementShippingDropshippingEcommerceMulti-ChannelFulfillmentLogistics

Properties

Name	Type	Description
type	string
cost	number
id	integer
company_id	integer
name	string
sku	string
taxable	string
weight	number
length	integer
width	integer
height	integer
price	number
customer_text	object
internal_notes	object
total_on_hand	number
category	string
is_kit_parent	boolean
archive_date	object
hs_code	object
country_of_origin	object
customs_description	object
created	string
updated	string
upc	object
asin	object
image_url	object
default_image_id	object
_link	object
tags	array
total_committed	number
total_available	number
total_allocated	number
total_unallocated	number
po_total_committed	number
fulfillment_type	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ordoro/refs/heads/main/json-schema/ordoro-product_base-schema.json",
  "title": "Product Schema",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "example": "Tangible"
    },
    "cost": {
      "type": "number",
      "example": 4.95
    },
    "id": {
      "type": "integer",
      "example": 19551105
    },
    "company_id": {
      "type": "integer",
      "example": 1985
    },
    "name": {
      "type": "string",
      "example": "Flux Capacitor"
    },
    "sku": {
      "type": "string",
      "example": "outa-time"
    },
    "taxable": {
      "type": "string"
    },
    "weight": {
      "type": "number",
      "example": 1.21
    },
    "length": {
      "type": "integer",
      "example": 12
    },
    "width": {
      "type": "integer",
      "example": 4
    },
    "height": {
      "type": "integer",
      "example": 8
    },
    "price": {
      "type": "number",
      "example": 19.55
    },
    "customer_text": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "internal_notes": {
      "example": "Be sure to include the complimentary almanac",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "total_on_hand": {
      "type": "number"
    },
    "category": {
      "type": "string",
      "example": "misc-timetravel"
    },
    "is_kit_parent": {
      "type": "boolean",
      "example": false
    },
    "archive_date": {
      "format": "date-time",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "hs_code": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "country_of_origin": {
      "example": "US",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "customs_description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "example": "2015-10-26T15:44:17.993588-06:00"
    },
    "updated": {
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T17:54:05.158248-06:00"
    },
    "upc": {
      "example": "847509005811",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "asin": {
      "example": "B07WXJHZ1L",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "image_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "default_image_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "_link": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/v3_tag"
      }
    },
    "total_committed": {
      "type": "number"
    },
    "total_available": {
      "type": "number"
    },
    "total_allocated": {
      "type": "number"
    },
    "total_unallocated": {
      "type": "number"
    },
    "po_total_committed": {
      "type": "number"
    },
    "fulfillment_type": {
      "enum": [
        "in_house",
        "dropshippable",
        "automatically_dropshipped"
      ],
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}