Otter · JSON Structure

Public Api Create Shipment Line Item Structure

CreateShipmentLineItem schema from Public API (Otter Public API).

Type: object Properties: 6 Required: 1
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

CreateShipmentLineItem is a JSON Structure definition published by Otter, describing 6 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id slug externalId manifestQuantity receivedSellableQuantity receivedUnsellableQuantity

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-structure/public-api-create-shipment-line-item-structure.json",
  "name": "CreateShipmentLineItem",
  "description": "CreateShipmentLineItem schema from Public API (Otter Public API).",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A CSS SKU UUID for the product. One of id, slug or externalId is required.",
      "example": "1b8aec80-21aa-43f1-b510-2199ac54156a"
    },
    "slug": {
      "type": "string",
      "description": "A CSS SKU slug for the product. One of id, slug or externalId is required.",
      "example": "pizza-pepperoni-12-inch"
    },
    "externalId": {
      "type": "string",
      "description": "A SKU external ID for the product. One of id, slug or externalId is required.",
      "example": "id-in-external-system"
    },
    "manifestQuantity": {
      "type": "int32",
      "description": "The expected quantity of the product in the shipment.",
      "example": 5
    },
    "receivedSellableQuantity": {
      "type": "int32",
      "description": "The quantity of the product in the shipment received that was sellable.",
      "example": 5
    },
    "receivedUnsellableQuantity": {
      "type": "int32",
      "description": "The quantity of the product in the shipment received that was unsellable (damaged, expired, etc.).",
      "example": 5
    }
  },
  "required": [
    "manifestQuantity"
  ]
}