SAP Commerce Cloud · Schema

Consignment

B2BB2CCommerceCustomer ExperienceEcommerceOmnichannelRetail

Properties

Name Type Description
code string Consignment code
status string Consignment status
statusDisplay string Display-friendly status
trackingID string Shipment tracking ID
entries array
deliveryPointOfService object
View JSON Schema on GitHub

JSON Schema

sap-commerce-cloud-consignment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Consignment",
  "title": "Consignment",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Consignment code"
    },
    "status": {
      "type": "string",
      "description": "Consignment status"
    },
    "statusDisplay": {
      "type": "string",
      "description": "Display-friendly status"
    },
    "trackingID": {
      "type": "string",
      "description": "Shipment tracking ID"
    },
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConsignmentEntry"
      }
    },
    "deliveryPointOfService": {
      "$ref": "#/components/schemas/PointOfService"
    }
  }
}