@shushed/helpers 0.0.289 → 0.0.291

package/dist/cjs/contracts/order/address.schema.json

@@ -45,54 +45,50 @@
         },
         "company_name": {
             "type": "string",
-            "maxLength": 30
+            "maxLength": 100
         },
         "first_name": {
-            "type": "string",
-            "maxLength": 30,
-            "minLength": 1,
+            "type": ["string", "null"],
+            "maxLength": 50,
             "faker": { "name.firstName": [] },
-            "description": "Recipient's first name."
+            "description": "Recipient's first name. Null for company/press orders without individual names."
         },
         "last_name": {
-            "type": "string",
-            "maxLength": 30,
-            "minLength": 1,
+            "type": ["string", "null"],
+            "maxLength": 50,
             "faker": { "name.lastName": [] },
-            "description": "Recipient's last name."
+            "description": "Recipient's last name. Null for company/press orders without individual names."
         },
         "address1": {
             "type": ["string"],
             "minLength": 1,
-            "maxLength": 30,
+            "maxLength": 100,
             "faker": { "address.streetAddress": [] },
             "description": "Primary street address."
         },
         "address2": {
             "type": ["string", "null"],
-            "maxLength": 30,
+            "maxLength": 100,
             "faker": { "address.secondaryAddress": [] },
             "description": "Additional address line (e.g., apartment or suite number)."
         },
         "city": {
-            "type": ["string"],
-            "maxLength": 30,
-            "minLength": 1,
+            "type": ["string", "null"],
+            "maxLength": 50,
             "faker": { "address.city": [] },
-            "description": "City or locality of the address."
+            "description": "City or locality of the address. Null when not provided in BC source data."
         },
         "region": {
             "type": ["string", "null"],
-            "maxLength": 30,
+            "maxLength": 50,
             "faker": { "address.state": [] },
             "description": "State, province, or region of the address."
         },
         "post_code": {
             "type": ["string", "null"],
             "maxLength": 20,
-            "pattern": "^[A-Z0-9 ]*$",
             "faker": { "address.zipCode": [] },
-            "description": "Postal code (uppercase letters and numbers with spaces; optional for countries without postal codes).",
+            "description": "Postal code (optional for countries without postal codes).",
             "examples": ["SW1A 1AA", "90210", null]
         },
         "country_code": {

package/dist/cjs/contracts/order/item.schema.json

@@ -139,7 +139,12 @@
                     "description": "Voucher code or campaign name for the purchase"
                 },
                 "cost_net": {
-                    "$ref": "https://shushed.example.com/money.schema.json"
+                    "$ref": "https://shushed.example.com/money.schema.json",
+                    "description": "Net cost per unit in smallest currency unit (from unit_cost_lcy)."
+                },
+                "order_line_no": {
+                    "type": ["integer", "null"],
+                    "description": "Original order line number from BC sales/invoice line. Used for cross-document tracing."
                 }
             },
             "required": [

package/dist/cjs/contracts/order/payment.schema.json

@@ -35,9 +35,9 @@
             "description": "The method used for the transaction."
         },
         "transaction_id": {
-            "type": ["string"],
+            "type": ["string", "null"],
             "faker": { "custom.documentid": ["TR", 10] },
-            "description": "Internal transaction reference ID."
+            "description": "Internal transaction reference ID. Derived from card_payment.transaction_id, payment.payment_gateway_token, or null if unavailable."
         },
         "card_number": {
             "type": ["string", "null"],
@@ -70,9 +70,9 @@
             "description": "Channel through which the payment was initiated."
         },
         "psp_reference": {
-            "type": "string",
+            "type": ["string", "null"],
             "faker": { "custom.documentid": ["PSP", 10] },
-            "description": "Reference provided by the Payment Service Provider (PSP)."
+            "description": "Reference provided by the Payment Service Provider (PSP). Same as transaction_id."
         },
         "card_brand": {
             "type": ["string", "null"],

package/dist/cjs/contracts/order/shipment/item.schema.json

@@ -11,6 +11,11 @@
             "faker": { "datatype.number": [1, 1] },
             "description": "Line number of the item in the order. Used for item referencing and tracking."
         },
+        "sku": {
+            "type": ["string"],
+            "faker": { "custom.sku": [] },
+            "description": "Stock Keeping Unit identifier matching the order item SKU (item_no-variant_code)."
+        },
         "quantity": {
             "type": ["integer"],
             "minimum": 1,
@@ -18,5 +23,5 @@
             "description": "The number of units of the item shipped."
         }
     },
-    "required": ["lineNumber", "quantity"]
+    "required": ["lineNumber", "sku", "quantity"]
 }

package/dist/cjs/contracts/order/shipment.schema.json

@@ -71,6 +71,20 @@
                     ],
                     "description": "Voucher code or campaign name for the purchase"
                 },
+                "courier_name": {
+                    "type": ["string", "null"],
+                    "enum": ["GLOBALE", "ROYALMAIL", "EVRI", "WAITROSE", null],
+                    "description": "Name of the courier/shipping carrier handling the shipment."
+                },
+                "tracking_code": {
+                    "type": ["string", "null"],
+                    "description": "Tracking code or reference number provided by the courier."
+                },
+                "class_name": {
+                    "type": ["string"],
+                    "enum": ["STANDARD", "PRIORITY"],
+                    "description": "Shipping service class. PRIORITY for express/24-hour, STANDARD for economy/48-hour."
+                },
                 "items": {
                     "type": [
                         "array"

package/dist/cjs/contracts/order.schema.json

@@ -22,12 +22,12 @@
                 "ARCHIVED",
                 "FAILED"
             ],
-            "description": "Current status of the order in the order lifecycle - Example: PENDING"
+            "description": "Current status of the order in the order lifecycle. Derived from shipment/return state: PROCESSED (no shipments), SHIPPED/PARTIALLY-SHIPPED (by shipped value), RETURNED/PARTIALLY-RETURNED (by credit memo value)."
         },
         "erp_order_id": {
             "type": "string",
             "faker": { "custom.documentid": ["MOCK", "8"] },
-            "description": "Unique order identifier assigned by the ERP system - Example: XX12345678"
+            "description": "Unique order identifier assigned by the ERP system (Master Order No.) - Example: UK00012345"
         },
         "centra_order_id": {
             "type": ["integer", "null"],
@@ -35,22 +35,21 @@
         },
         "sfcc_order_id": {
             "type": ["string", "null"],
-            "description": "Salesforce Commerce Cloud order identifier, nullable if not applicable - Example: XX123456789 or null"
+            "description": "Salesforce Commerce Cloud order identifier. Set from sale.no when created_by is STOREFRONT, else invoice.order_no. Nullable if not applicable."
         },
         "globale_order_id": {
             "type": ["string", "null"],
             "faker": { "custom.documentid": ["GEMOCK", "16"] },
-            "description": "Identifier for Globale orders, nullable if not applicable - Example: GE00025734 or null"
+            "description": "Identifier for Global-E orders, sourced from invoice or sale globale_order_id. Nullable if not applicable."
         },
         "sitoo_order_id": {
             "type": ["string", "null"],
-            "format": "uuid",
-            "description": "Sitoo POS system order identifier, nullable if not applicable - Example: XX10008732 or null"
+            "description": "Sitoo POS system order identifier from master order. Nullable if not applicable."
         },
         "system_created_by": {
             "type": "string",
             "enum": ["POS", "ECOMMERCE", "SYSTEM"],
-            "description": "Origin system or actor that created the order record - Example: POS"
+            "description": "Origin system that created the order: POS (from SITOO created_by), ECOMMERCE (from STOREFRONT), SYSTEM (default)."
         },
         "ordered_at": {
             "type": "string",
@@ -58,7 +57,7 @@
             "faker": {
                 "date.between": ["2024-01-01T00:00:00.000Z", "2025-04-30T00:00:00.000Z"]
             },
-            "description": "Timestamp when the order was placed - Example: 2024-12-25T15:30:00Z"
+            "description": "Timestamp when the order was placed. Priority: master_order.ordered_at > created_at > sale.system_created_at > earliest invoice.system_created_at."
         },
         "payments": {
             "type": "array",
@@ -68,20 +67,20 @@
                 "maxItems": 2,
                 "uniqueItems": true
             },
-            "description": "List of payment transactions related to this order.",
+            "description": "Grouped payment transactions. Card payments and payment/refund entries are grouped by transaction_id/payment_gateway_token. Status: CAPTURED (successful), FAILED (declined), CANCELLED.",
             "example": [
                 {
                     "type": "CHARGE",
                     "created_at": "2024-12-25T15:35:00Z",
                     "payment_method": "CREDIT-CARD",
                     "transaction_id": "TR123456789",
-                    "card_number": "4111111111111111",
-                    "journey_label": "CHECKOUT",
-                    "psp_reference": "PSP987654321",
-                    "card_brand": "VISA",
+                    "card_number": "XXXX-XXXX-XXXX-1234",
+                    "journey_label": null,
+                    "psp_reference": "TR123456789",
+                    "card_brand": "Visa",
                     "status": "CAPTURED",
-                    "amount": { "currency": "USD", "value": 15000 },
-                    "created_by": "CUSTOMER"
+                    "amount": { "currency": "GBP", "value": 15000, "decimal_places": 2, "lcy_value": 15000, "lcy_currency": "GBP", "lcy_decimal_places": 2 },
+                    "created_by": "MOTO"
                 }
             ]
         },
@@ -91,28 +90,31 @@
         },
         "is_gift": {
             "type": ["boolean"],
-            "description": "Indicates if the order is marked as a gift - Example: true or false"
+            "description": "Derived from presence of gift_message on sale or invoice headers."
+        },
+        "is_pos": {
+            "type": ["boolean"],
+            "description": "True when order originated from POS (created_by is SITOO)."
         },
         "customer": {
             "$ref": "https://shushed.example.com/order/customer.schema.json",
-            "description": "Customer details related to this order - Example: {}"
+            "description": "Customer details from BC customer record: first_name, surname, email, phone, addresses."
         },
         "billing_address": {
             "anyOf": [
                 { "$ref": "https://shushed.example.com/order/address.schema.json" },
                 { "type": ["null"] }
             ],
-            "description": "Billing address for the order, nullable if unavailable.",
+            "description": "Billing address from invoice or sale header bill_to_* fields.",
             "example": {
                 "first_name": "Alice",
                 "last_name": "Johnson",
                 "address1": "123 Main St",
                 "address2": "Apt 4B",
-                "city": "New York",
-                "region": "NY",
-                "post_code": "10001",
-                "country_code": "US",
-                "phone": "+1-202-555-0143"
+                "city": "London",
+                "post_code": "SW1A 1AA",
+                "country_code": "GB",
+                "phone": "+44 7700 900000"
             }
         },
         "shipping_address": {
@@ -120,27 +122,22 @@
                 { "$ref": "https://shushed.example.com/order/address.schema.json" },
                 { "type": ["null"] }
             ],
-            "description": "Shipping address for the order, nullable if unavailable.",
+            "description": "Shipping address from invoice or sale header ship_to_* fields.",
             "example": {
                 "first_name": "Alice",
                 "last_name": "Johnson",
                 "address1": "123 Main St",
                 "address2": "Apt 4B",
-                "city": "New York",
-                "region": "NY",
-                "post_code": "10001",
-                "country_code": "US",
-                "phone": "+1-202-555-0143"
+                "city": "London",
+                "post_code": "SW1A 1AA",
+                "country_code": "GB",
+                "phone": "+44 7700 900000"
             }
         },
         "collection_point_id": {
-            "type": [
-                "string",
-                "null"
-            ],
-            "description": "Collection point ID reference if applicable - Example: EVRI-S41902"
+            "type": ["string", "null"],
+            "description": "Collection point ID reference for click-and-collect orders - Example: EVRI-S41902"
         },
-        "is_pos": { "type": ["boolean"], "description": "Flag indicating if the order was placed via a POS system example: true or false" },
         "shipments": {
             "type": "array",
             "minItems": 1,
@@ -177,19 +174,22 @@
                 "maxItems": 2,
                 "uniqueItems": true
             },
-            "description": "List of shipments related to the order, including outbound and return shipments",
+            "description": "Outbound shipments from Sales Shipment Header and return shipments from Sales Cr.Memo Header. Status: SHIPPED (outbound with items), PENDING (outbound without items), RECEIVED (returns).",
             "example": [
                 {
                     "erp_id": "SP123456789",
                     "type": "SHIPPED-OUTBOUND",
                     "shipped_at": "2024-12-26T10:00:00Z",
                     "status": "SHIPPED",
+                    "shipped_by": "TORQUE",
+                    "courier_name": "EVRI",
+                    "tracking_code": "TRK002345678901",
+                    "class_name": "PRIORITY",
                     "items": [
                         {
-                            "sku": "SKU123",
-                            "quantity": 1,
-                            "unit_price_net": { "currency": "USD", "value": 10000 },
-                            "unit_price_gross": { "currency": "USD", "value": 12000 }
+                            "lineNumber": 1,
+                            "sku": "PROD004-4001-14",
+                            "quantity": 1
                         }
                     ]
                 }
@@ -204,27 +204,27 @@
                 "maxItems": 2,
                 "uniqueItems": true
             },
-            "description": "List of items included in the order.",
+            "description": "Order line items from invoice lines (preferred) or sale lines. Items are split when shipped quantity < ordered quantity.",
             "example": [
                 {
-                    "sku": "SKU123",
-                    "colour_id": "RED",
-                    "style_id": "STYLE1",
+                    "sku": "PROD004-4001-14",
+                    "colour_id": "4001",
+                    "style_id": "PROD004",
+                    "product_id": "PROD004-4001",
                     "quantity": 1,
-                    "unit_price_net": { "currency": "USD", "value": 10000 },
-                    "unit_price_gross": { "currency": "USD", "value": 12000 },
-                    "unit_price_status": "rrp",
-                    "discount_amount_net": { "currency": "USD", "value": 0 },
-                    "discount_amount_gross": { "currency": "USD", "value": 0 }
+                    "returned_quantity": 0,
+                    "unit_price_net": { "currency": "GBP", "value": 6584, "decimal_places": 2, "lcy_value": 6584, "lcy_currency": "GBP", "lcy_decimal_places": 2 },
+                    "unit_price_gross": { "currency": "GBP", "value": 7900, "decimal_places": 2, "lcy_value": 7900, "lcy_currency": "GBP", "lcy_decimal_places": 2 },
+                    "unit_price_status": "perm"
                 }
             ]
         },
-        "total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Total monetary value of the order." },
-        "return_total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Total monetary value of returned items." },
-        "net_total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Net total amount after discounts and returns." },
+        "total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Total monetary value of the order (invoices + non-invoiced sales, including delivery)." },
+        "return_total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Total monetary value of returned items from credit memos." },
+        "net_total": { "$ref": "https://shushed.example.com/total.schema.json", "description": "Net total: total minus return_total." },
         "shipping_method": {
             "type": ["string", "null"],
-            "description": "Shipping method used for the order, nullable if not applicable - Example: EMAILDELIVERY, GLOBALE_HUB, GLOBALE_EXPRESS"
+            "description": "Shipping method code from shipment shipping_agent_service_code or shipping_agent_code. Nullable when no shipments exist."
         }
     },
     "required": ["erp_order_id", "status", "ordered_at", "items", "total"]

package/dist/cjs/dist-dereferenced/messages/order/delivered.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const schema = { "$schema": "http://json-schema.org/draft-07/schema#", "title": "OrderDelivered", "additionalProperties": false, "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order", "type": "object", "properties": { "status": { "type": ["string"], "enum": ["NEW", "PENDING", "CONFIRMED", "PROCESSING", "PROCESSED", "PACKED", "SHIPPED", "DELIVERED", "PARTIALLY-SHIPPED", "RETURNED", "PARTIALLY-RETURNED", "CANCELLED", "ARCHIVED", "FAILED"] }, "erp_order_id": { "type": "string" }, "centra_order_id": { "type": ["integer", "null"] }, "sfcc_order_id": { "type": ["string", "null"] }, "globale_order_id": { "type": ["string", "null"] }, "sitoo_order_id": { "type": ["string", "null"], "format": "uuid" }, "system_created_by": { "type": "string", "enum": ["POS", "ECOMMERCE", "SYSTEM"] }, "ordered_at": { "type": "string", "format": "date-time" }, "payments": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Payment", "type": "object", "additionalProperties": true, "properties": { "type": { "type": "string", "enum": ["REFUND", "CHARGE"] }, "additionalProperties": false, "created_at": { "type": "string", "format": "date-time", "example": "2024-07-09T14:30:00Z", "nullable": true }, "payment_method": { "type": "string", "enum": ["MOTO", "CREDIT-CARD", "GIFT-CARD", "PAYPAL", "APPLE-PAY", "OTHER"] }, "transaction_id": { "type": ["string"] }, "card_number": { "type": ["string", "null"] }, "card_holder": { "type": ["string", "null"] }, "card_token": { "type": ["string", "null"] }, "expiration_month": { "type": ["integer", "null"], "minimum": 1, "maximum": 12 }, "expiration_year": { "type": ["integer", "null"], "minimum": 2023, "maximum": 2085 }, "journey_label": { "type": ["string", "null"], "enum": ["CHECKOUT", "POS", "EXPRESS", "MOTO", "SYSTEM", null] }, "psp_reference": { "type": "string" }, "card_brand": { "type": ["string", "null"] }, "status": { "type": ["string"], "enum": ["CAPTURED", "FAILED", "FAILED-3DS", "CANCELLED"] }, "amount": { "$ref": "#/allOf/0/properties/items/items/allOf/1/properties/cost_net" }, "created_by": { "anyOf": [{ "type": "string", "enum": ["CUSTOMER", "SYSTEM", "CENTRA", "SITOO", "STOREFRONT", "MOTO"] }, { "type": "string", "format": "email" }] } }, "required": ["created_at", "payment_method", "transaction_id", "psp_reference", "status", "amount", "created_by", "journey_label"] }, "example": [{ "type": "CHARGE", "created_at": "2024-12-25T15:35:00Z", "payment_method": "CREDIT-CARD", "transaction_id": "TR123456789", "card_number": "4111111111111111", "journey_label": "CHECKOUT", "psp_reference": "PSP987654321", "card_brand": "VISA", "status": "CAPTURED", "amount": { "currency": "USD", "value": 15000 }, "created_by": "CUSTOMER" }] }, "is_anonymous": { "type": ["boolean"] }, "is_gift": { "type": ["boolean"] }, "customer": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Customer", "type": "object", "additionalProperties": false, "properties": { "first_name": { "type": "string", "maxLength": 30 }, "last_name": { "type": "string", "maxLength": 30 }, "sfcc_id": { "type": "string" }, "bc_customer_id": { "type": "string", "maxLength": 20 }, "merged_bc_customer_ids": { "type": "array", "items": { "type": "string" }, "example": ["CUST00011111", "CUST00022222"] }, "centra_id": { "type": "string" }, "sitoo_id": { "type": "string" }, "scv_customer_id": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#/allOf/0/properties/billing_address/anyOf/0" } }, "default_shipping_address": { "$ref": "#/allOf/0/properties/billing_address/anyOf/0" }, "phone": { "type": ["string", "null"] }, "email": { "type": ["string", "null"], "format": "email", "example": "alice.johnson@example.com" }, "opt_in_email": { "type": "boolean" }, "opt_in_phone": { "type": "boolean" }, "opt_in_3rdparty": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "string" }, "example": ["VIP", "NewsletterSubscriber"] }, "registered_at": { "type": "string", "format": "date-time" }, "scv_first_purchase_at": { "type": "string", "format": "date-time" }, "scv_last_purchase_at": { "type": "string", "format": "date-time" }, "scv_linked_customer_ids": { "type": "array", "items": { "type": "string" }, "example": ["SCV987654321", "SCV123987654"] }, "scv_total_transactions": { "type": "integer", "minimum": 0 }, "scv_total_demand": { "type": "integer", "minimum": 0 }, "scv_total_demand_cost": { "type": "number", "minimum": 0 }, "scv_total_returns": { "type": "integer", "minimum": 0 }, "scv_total_returns_cost": { "type": "number", "minimum": 0 }, "last_modified_by": { "type": "string" }, "is_deleted": { "type": "boolean" }, "other_bc_ids": { "type": "array", "items": { "type": "string" } } }, "required": ["email"] }, "billing_address": { "anyOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Address", "type": "object", "additionalProperties": false, "properties": { "address_id": { "type": "string" }, "sfcc_customer_id": { "type": "string" }, "sitoo_customer_id": { "type": "string" }, "bc_customer_id": { "type": "string" }, "centra_customer_id": { "type": "string" }, "is_default_billing": { "type": "boolean" }, "is_default_shipping": { "type": "boolean" }, "scv_household_id": { "type": ["string", "null"] }, "is_last_used_shipping": { "type": "boolean" }, "is_retrieved_from_payment_method": { "type": "boolean" }, "opt_in_mail": { "type": "boolean" }, "company_name": { "type": "string", "maxLength": 30 }, "first_name": { "type": "string", "maxLength": 30, "minLength": 1 }, "last_name": { "type": "string", "maxLength": 30, "minLength": 1 }, "address1": { "type": ["string"], "minLength": 1, "maxLength": 30 }, "address2": { "type": ["string", "null"], "maxLength": 30 }, "city": { "type": ["string"], "maxLength": 30, "minLength": 1 }, "region": { "type": ["string", "null"], "maxLength": 30 }, "post_code": { "type": ["string", "null"], "maxLength": 20, "pattern": "^[A-Z0-9 ]*$" }, "country_code": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Country", "type": "string", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CD", "CG", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"] }, "phone": { "type": ["string", "null"], "maxLength": 30 }, "click_collect_id": { "type": ["string", "null"] }, "created_at": { "type": "string", "format": "date-time" }, "last_modified_at": { "type": "string", "format": "date-time" } }, "required": ["first_name", "last_name", "address1", "city", "country_code"] }, { "type": ["null"] }], "example": { "first_name": "Alice", "last_name": "Johnson", "address1": "123 Main St", "address2": "Apt 4B", "city": "New York", "region": "NY", "post_code": "10001", "country_code": "US", "phone": "+1-202-555-0143" } }, "shipping_address": { "anyOf": [{ "$ref": "#/allOf/0/properties/billing_address/anyOf/0" }, { "type": ["null"] }], "example": { "first_name": "Alice", "last_name": "Johnson", "address1": "123 Main St", "address2": "Apt 4B", "city": "New York", "region": "NY", "post_code": "10001", "country_code": "US", "phone": "+1-202-555-0143" } }, "collection_point_id": { "type": ["string", "null"] }, "is_pos": { "type": ["boolean"] }, "shipments": { "type": "array", "minItems": 1, "prefixItems": [{ "anyOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0" }, { "$ref": "#/allOf/0/properties/shipments/items/anyOf/2" }] }], "items": { "anyOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Shipped Outbound", "type": "object", "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Shipment", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/items/items/allOf/0" }, { "type": "object", "properties": { "erp_id": { "type": ["string"] }, "type": { "type": ["string"], "enum": ["SHIPPED-OUTBOUND", "SHIPPED-RETURN", "POS-OUTBOUND", "POS-RETURN"] }, "shipped_at": { "type": ["string"], "format": "date-time" }, "status": { "type": ["string"], "enum": ["PENDING", "SHIPPED", "RECEIVED", "CANCELLED"] }, "discount_code": { "type": ["string", "null"] }, "discount_campaign": { "type": ["string", "null"] }, "items": { "type": ["array"], "items": { "type": "object", "anyOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" }, { "$ref": "#/allOf/0/properties/shipments/items/anyOf/3/allOf/1/properties/items/items" }] } } } }], "required": ["erp_id", "shipped_at", "status", "items"] }, { "type": "object", "properties": { "type": { "type": ["string"], "enum": ["SHIPPED-OUTBOUND"] }, "shipped_by": { "type": ["string"], "enum": ["TORQUE", "GLOBALE"] }, "items": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Item", "type": "object", "properties": { "lineNumber": { "type": ["integer"], "minimum": 0 }, "quantity": { "type": ["integer"], "minimum": 1 } }, "required": ["lineNumber", "quantity"] } } } }] }, { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Shipped Return", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/0" }, { "type": "object", "properties": { "type": { "type": ["string"], "enum": ["SHIPPED-RETURN"] }, "shipped_by": { "type": ["string"], "enum": ["CUSTOMER"] }, "items": { "type": "array", "items": { "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" } } }, "required": ["type", "shipped_by", "items"] }] }, { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment POS Outbound", "type": "object", "additionalProperties": false, "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Outbound", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/0" }, { "type": "object", "properties": { "type": { "type": ["string"], "enum": ["POS-OUTBOUND", "POS-RETURN"] }, "status": { "type": ["string"], "enum": ["RECEIVED"] }, "store_id": { "type": ["string", "null"] }, "store_name": { "type": ["string", "null"] }, "associate_id": { "type": ["string", "null"] }, "associate_name": { "type": ["string", "null"] } }, "required": ["store_id", "store_name", "associate_id", "associate_name"] }] }, { "type": "object", "additionalProperties": false, "properties": { "type": { "type": ["string"], "enum": ["POS-OUTBOUND"] }, "shipped_by": { "type": ["string"], "enum": ["TORQUE", "GLOBALE"] }, "items": { "type": "array", "items": { "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" } } }, "required": ["type", "shipped_by", "items"] }] }, { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment POS Return", "type": "object", "additionalProperties": false, "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/2/allOf/0" }, { "type": "object", "additionalProperties": false, "properties": { "type": { "type": ["string"], "enum": ["POS-RETURN"] }, "items": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Item Returned", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" }, { "type": "object", "properties": { "returnReasonCode": { "type": ["string"] }, "returnReason": { "type": ["string", "null"] } }, "required": ["returnReasonCode", "returnReason"] }] } } } }] }] }, "example": [{ "erp_id": "SP123456789", "type": "SHIPPED-OUTBOUND", "shipped_at": "2024-12-26T10:00:00Z", "status": "SHIPPED", "items": [{ "sku": "SKU123", "quantity": 1, "unit_price_net": { "currency": "USD", "value": 10000 }, "unit_price_gross": { "currency": "USD", "value": 12000 } }] }] }, "items": { "type": "array", "minItems": 1, "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Item", "type": "object", "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Total", "type": "object", "properties": { "amount_net": { "$ref": "#/allOf/0/properties/items/items/allOf/1/properties/cost_net", "title": "Amount Net" }, "amount_gross": { "$ref": "#/allOf/0/properties/items/items/allOf/1/properties/cost_net", "title": "Amount gross" }, "discount_amount_net": { "$ref": "#/allOf/0/properties/items/items/allOf/1/properties/cost_net", "title": "Discount Amount Net" }, "discount_amount_gross": { "$ref": "#/allOf/0/properties/items/items/allOf/1/properties/cost_net", "title": "Discount Amount Gross" }, "discount_amount_percent": { "type": "number", "title": "Discount Amount Percent", "minimum": 0, "maximum": 100 } }, "required": ["amount_net", "amount_gross", "discount_amount_net", "discount_amount_gross", "discount_amount_percent"] }, { "type": "object", "properties": { "sku": { "type": ["string"] }, "linked_style_id": { "type": ["string", "null"] }, "colour_id": { "type": ["string", "null"] }, "style_id": { "type": ["string", "null"] }, "product_id": { "type": ["string", "null"] }, "colour_name": { "type": ["string"] }, "size_name": { "type": ["string"] }, "preorder_date": { "type": ["string", "null"], "format": "date" }, "quantity": { "type": ["integer"], "minimum": 0 }, "unit_price_status": { "type": "string", "enum": ["rrp", "perm", "pos"] }, "returned_quantity": { "type": ["integer"], "minimum": 0 }, "unit_price_net": { "$ref": "#/allOf/0/properties/items/items/allOf/1/properties/cost_net" }, "unit_price_gross": { "$ref": "#/allOf/0/properties/items/items/allOf/1/properties/cost_net" }, "discount_code": { "type": ["string", "null"] }, "discount_campaign": { "type": ["string", "null"] }, "cost_net": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Money", "type": "object", "additionalProperties": false, "properties": { "value": { "type": "integer", "minimum": 0 }, "decimal_places": { "type": "integer", "minimum": 0, "maximum": 4 }, "currency": { "title": "Currency", "$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "enum": ["AFN", "ALL", "DZD", "USD", "EUR", "AOA", "XCD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "XOF", "BMD", "BTN", "INR", "BOB", "BOV", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "CVE", "KHR", "XAF", "CAD", "KYD", "CLF", "CLP", "CNY", "COP", "COU", "KMF", "CDF", "NZD", "CRC", "CUC", "CUP", "ANG", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "ETB", "FKP", "FJD", "XPF", "GMD", "GEL", "GHS", "GIP", "GTQ", "GBP", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "IDR", "XDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "ZAR", "LRD", "LYD", "CHF", "MOP", "MGA", "MWK", "MYR", "MVR", "MRU", "MUR", "XUA", "MXN", "MXV", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "OMR", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "MKD", "RON", "RUB", "RWF", "SHP", "WST", "STN", "SAR", "RSD", "SCR", "SLE", "SGD", "XSU", "SBD", "SOS", "SSP", "LKR", "SDG", "SRD", "SZL", "SEK", "CHE", "CHW", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "USN", "UYI", "UYU", "UZS", "VUV", "VEF", "VED", "VND", "YER", "ZMW", "ZWL"] }, "lcy_value": { "type": "integer", "minimum": 0 }, "lcy_currency": { "$ref": "#/allOf/0/properties/total/properties/amount_net/properties/currency", "title": "LCY Currency" }, "lcy_decimal_places": { "type": "integer", "minimum": 0, "maximum": 4 } }, "required": ["value", "currency", "lcy_value", "lcy_currency", "decimal_places", "lcy_decimal_places"] } }, "required": ["sku", "colour_id", "style_id", "quantity", "unit_price_net", "unit_price_gross", "unit_price_status"] }] }, "example": [{ "sku": "SKU123", "colour_id": "RED", "style_id": "STYLE1", "quantity": 1, "unit_price_net": { "currency": "USD", "value": 10000 }, "unit_price_gross": { "currency": "USD", "value": 12000 }, "unit_price_status": "rrp", "discount_amount_net": { "currency": "USD", "value": 0 }, "discount_amount_gross": { "currency": "USD", "value": 0 } }] }, "total": { "$ref": "#/allOf/0/properties/items/items/allOf/0" }, "return_total": { "$ref": "#/allOf/0/properties/items/items/allOf/0" }, "net_total": { "$ref": "#/allOf/0/properties/items/items/allOf/0" }, "shipping_method": { "type": ["string", "null"] } }, "required": ["erp_order_id", "status", "ordered_at", "items", "total"] }, { "type": "object", "additionalProperties": false, "properties": { "status": { "type": ["string"], "enum": ["SHIPPED", "PARTIALLY-SHIPPED", "RETURNED", "PARTIALLY-RETURNED", "CANCELLED"] } }, "required": ["erp_order_id", "shipments", "items", "total"] }], "$id": "https://shushed.example.com/messages/order/delivered.schema.json" };
+const schema = { "$schema": "http://json-schema.org/draft-07/schema#", "title": "OrderDelivered", "additionalProperties": false, "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order", "type": "object", "properties": { "status": { "type": ["string"], "enum": ["NEW", "PENDING", "CONFIRMED", "PROCESSING", "PROCESSED", "PACKED", "SHIPPED", "DELIVERED", "PARTIALLY-SHIPPED", "RETURNED", "PARTIALLY-RETURNED", "CANCELLED", "ARCHIVED", "FAILED"] }, "erp_order_id": { "type": "string" }, "centra_order_id": { "type": ["integer", "null"] }, "sfcc_order_id": { "type": ["string", "null"] }, "globale_order_id": { "type": ["string", "null"] }, "sitoo_order_id": { "type": ["string", "null"] }, "system_created_by": { "type": "string", "enum": ["POS", "ECOMMERCE", "SYSTEM"] }, "ordered_at": { "type": "string", "format": "date-time" }, "payments": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Payment", "type": "object", "additionalProperties": true, "properties": { "type": { "type": "string", "enum": ["REFUND", "CHARGE"] }, "additionalProperties": false, "created_at": { "type": "string", "format": "date-time", "example": "2024-07-09T14:30:00Z", "nullable": true }, "payment_method": { "type": "string", "enum": ["MOTO", "CREDIT-CARD", "GIFT-CARD", "PAYPAL", "APPLE-PAY", "OTHER"] }, "transaction_id": { "type": ["string", "null"] }, "card_number": { "type": ["string", "null"] }, "card_holder": { "type": ["string", "null"] }, "card_token": { "type": ["string", "null"] }, "expiration_month": { "type": ["integer", "null"], "minimum": 1, "maximum": 12 }, "expiration_year": { "type": ["integer", "null"], "minimum": 2023, "maximum": 2085 }, "journey_label": { "type": ["string", "null"], "enum": ["CHECKOUT", "POS", "EXPRESS", "MOTO", "SYSTEM", null] }, "psp_reference": { "type": ["string", "null"] }, "card_brand": { "type": ["string", "null"] }, "status": { "type": ["string"], "enum": ["CAPTURED", "FAILED", "FAILED-3DS", "CANCELLED"] }, "amount": { "$ref": "#/allOf/0/properties/total/properties/amount_net" }, "created_by": { "anyOf": [{ "type": "string", "enum": ["CUSTOMER", "SYSTEM", "CENTRA", "SITOO", "STOREFRONT", "MOTO"] }, { "type": "string", "format": "email" }] } }, "required": ["created_at", "payment_method", "transaction_id", "psp_reference", "status", "amount", "created_by", "journey_label"] }, "example": [{ "type": "CHARGE", "created_at": "2024-12-25T15:35:00Z", "payment_method": "CREDIT-CARD", "transaction_id": "TR123456789", "card_number": "XXXX-XXXX-XXXX-1234", "journey_label": null, "psp_reference": "TR123456789", "card_brand": "Visa", "status": "CAPTURED", "amount": { "currency": "GBP", "value": 15000, "decimal_places": 2, "lcy_value": 15000, "lcy_currency": "GBP", "lcy_decimal_places": 2 }, "created_by": "MOTO" }] }, "is_anonymous": { "type": ["boolean"] }, "is_gift": { "type": ["boolean"] }, "is_pos": { "type": ["boolean"] }, "customer": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Customer", "type": "object", "additionalProperties": false, "properties": { "first_name": { "type": "string", "maxLength": 30 }, "last_name": { "type": "string", "maxLength": 30 }, "sfcc_id": { "type": "string" }, "bc_customer_id": { "type": "string", "maxLength": 20 }, "merged_bc_customer_ids": { "type": "array", "items": { "type": "string" }, "example": ["CUST00011111", "CUST00022222"] }, "centra_id": { "type": "string" }, "sitoo_id": { "type": "string" }, "scv_customer_id": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#/allOf/0/properties/billing_address/anyOf/0" } }, "default_shipping_address": { "$ref": "#/allOf/0/properties/billing_address/anyOf/0" }, "phone": { "type": ["string", "null"] }, "email": { "type": ["string", "null"], "format": "email", "example": "alice.johnson@example.com" }, "opt_in_email": { "type": "boolean" }, "opt_in_phone": { "type": "boolean" }, "opt_in_3rdparty": { "type": "boolean" }, "segments": { "type": "array", "items": { "type": "string" }, "example": ["VIP", "NewsletterSubscriber"] }, "registered_at": { "type": "string", "format": "date-time" }, "scv_first_purchase_at": { "type": "string", "format": "date-time" }, "scv_last_purchase_at": { "type": "string", "format": "date-time" }, "scv_linked_customer_ids": { "type": "array", "items": { "type": "string" }, "example": ["SCV987654321", "SCV123987654"] }, "scv_total_transactions": { "type": "integer", "minimum": 0 }, "scv_total_demand": { "type": "integer", "minimum": 0 }, "scv_total_demand_cost": { "type": "number", "minimum": 0 }, "scv_total_returns": { "type": "integer", "minimum": 0 }, "scv_total_returns_cost": { "type": "number", "minimum": 0 }, "last_modified_by": { "type": "string" }, "is_deleted": { "type": "boolean" }, "other_bc_ids": { "type": "array", "items": { "type": "string" } } }, "required": ["email"] }, "billing_address": { "anyOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Address", "type": "object", "additionalProperties": false, "properties": { "address_id": { "type": "string" }, "sfcc_customer_id": { "type": "string" }, "sitoo_customer_id": { "type": "string" }, "bc_customer_id": { "type": "string" }, "centra_customer_id": { "type": "string" }, "is_default_billing": { "type": "boolean" }, "is_default_shipping": { "type": "boolean" }, "scv_household_id": { "type": ["string", "null"] }, "is_last_used_shipping": { "type": "boolean" }, "is_retrieved_from_payment_method": { "type": "boolean" }, "opt_in_mail": { "type": "boolean" }, "company_name": { "type": "string", "maxLength": 100 }, "first_name": { "type": ["string", "null"], "maxLength": 50 }, "last_name": { "type": ["string", "null"], "maxLength": 50 }, "address1": { "type": ["string"], "minLength": 1, "maxLength": 100 }, "address2": { "type": ["string", "null"], "maxLength": 100 }, "city": { "type": ["string", "null"], "maxLength": 50 }, "region": { "type": ["string", "null"], "maxLength": 50 }, "post_code": { "type": ["string", "null"], "maxLength": 20 }, "country_code": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Country", "type": "string", "enum": ["AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CD", "CG", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"] }, "phone": { "type": ["string", "null"], "maxLength": 30 }, "click_collect_id": { "type": ["string", "null"] }, "created_at": { "type": "string", "format": "date-time" }, "last_modified_at": { "type": "string", "format": "date-time" } }, "required": ["first_name", "last_name", "address1", "city", "country_code"] }, { "type": ["null"] }], "example": { "first_name": "Alice", "last_name": "Johnson", "address1": "123 Main St", "address2": "Apt 4B", "city": "London", "post_code": "SW1A 1AA", "country_code": "GB", "phone": "+44 7700 900000" } }, "shipping_address": { "anyOf": [{ "$ref": "#/allOf/0/properties/billing_address/anyOf/0" }, { "type": ["null"] }], "example": { "first_name": "Alice", "last_name": "Johnson", "address1": "123 Main St", "address2": "Apt 4B", "city": "London", "post_code": "SW1A 1AA", "country_code": "GB", "phone": "+44 7700 900000" } }, "collection_point_id": { "type": ["string", "null"] }, "shipments": { "type": "array", "minItems": 1, "prefixItems": [{ "anyOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0" }, { "$ref": "#/allOf/0/properties/shipments/items/anyOf/2" }] }], "items": { "anyOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Shipped Outbound", "type": "object", "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Shipment", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/items/items/allOf/0" }, { "type": "object", "properties": { "erp_id": { "type": ["string"] }, "type": { "type": ["string"], "enum": ["SHIPPED-OUTBOUND", "SHIPPED-RETURN", "POS-OUTBOUND", "POS-RETURN"] }, "shipped_at": { "type": ["string"], "format": "date-time" }, "status": { "type": ["string"], "enum": ["PENDING", "SHIPPED", "RECEIVED", "CANCELLED"] }, "discount_code": { "type": ["string", "null"] }, "discount_campaign": { "type": ["string", "null"] }, "courier_name": { "type": ["string", "null"], "enum": ["GLOBALE", "ROYALMAIL", "EVRI", "WAITROSE", null] }, "tracking_code": { "type": ["string", "null"] }, "class_name": { "type": ["string"], "enum": ["STANDARD", "PRIORITY"] }, "items": { "type": ["array"], "items": { "type": "object", "anyOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" }, { "$ref": "#/allOf/0/properties/shipments/items/anyOf/3/allOf/1/properties/items/items" }] } } } }], "required": ["erp_id", "shipped_at", "status", "items"] }, { "type": "object", "properties": { "type": { "type": ["string"], "enum": ["SHIPPED-OUTBOUND"] }, "shipped_by": { "type": ["string"], "enum": ["TORQUE", "GLOBALE"] }, "items": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Item", "type": "object", "properties": { "lineNumber": { "type": ["integer"], "minimum": 0 }, "sku": { "type": ["string"] }, "quantity": { "type": ["integer"], "minimum": 1 } }, "required": ["lineNumber", "sku", "quantity"] } } } }] }, { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Shipped Return", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/0" }, { "type": "object", "properties": { "type": { "type": ["string"], "enum": ["SHIPPED-RETURN"] }, "shipped_by": { "type": ["string"], "enum": ["CUSTOMER"] }, "items": { "type": "array", "items": { "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" } } }, "required": ["type", "shipped_by", "items"] }] }, { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment POS Outbound", "type": "object", "additionalProperties": false, "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Outbound", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/0" }, { "type": "object", "properties": { "type": { "type": ["string"], "enum": ["POS-OUTBOUND", "POS-RETURN"] }, "status": { "type": ["string"], "enum": ["RECEIVED"] }, "store_id": { "type": ["string", "null"] }, "store_name": { "type": ["string", "null"] }, "associate_id": { "type": ["string", "null"] }, "associate_name": { "type": ["string", "null"] } }, "required": ["store_id", "store_name", "associate_id", "associate_name"] }] }, { "type": "object", "additionalProperties": false, "properties": { "type": { "type": ["string"], "enum": ["POS-OUTBOUND"] }, "shipped_by": { "type": ["string"], "enum": ["TORQUE", "GLOBALE"] }, "items": { "type": "array", "items": { "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" } } }, "required": ["type", "shipped_by", "items"] }] }, { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment POS Return", "type": "object", "additionalProperties": false, "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/2/allOf/0" }, { "type": "object", "additionalProperties": false, "properties": { "type": { "type": ["string"], "enum": ["POS-RETURN"] }, "items": { "type": "array", "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Order Shipment Item Returned", "type": "object", "allOf": [{ "$ref": "#/allOf/0/properties/shipments/items/anyOf/0/allOf/1/properties/items/items" }, { "type": "object", "properties": { "returnReasonCode": { "type": ["string"] }, "returnReason": { "type": ["string", "null"] } }, "required": ["returnReasonCode", "returnReason"] }] } } } }] }] }, "example": [{ "erp_id": "SP123456789", "type": "SHIPPED-OUTBOUND", "shipped_at": "2024-12-26T10:00:00Z", "status": "SHIPPED", "shipped_by": "TORQUE", "courier_name": "EVRI", "tracking_code": "TRK002345678901", "class_name": "PRIORITY", "items": [{ "lineNumber": 1, "sku": "PROD004-4001-14", "quantity": 1 }] }] }, "items": { "type": "array", "minItems": 1, "items": { "$schema": "http://json-schema.org/draft-07/schema#", "title": "Item", "type": "object", "allOf": [{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Total", "type": "object", "properties": { "amount_net": { "title": "Amount Net", "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": { "value": { "type": "integer", "minimum": 0 }, "decimal_places": { "type": "integer", "minimum": 0, "maximum": 4 }, "currency": { "title": "Currency", "$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "enum": ["AFN", "ALL", "DZD", "USD", "EUR", "AOA", "XCD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "XOF", "BMD", "BTN", "INR", "BOB", "BOV", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "CVE", "KHR", "XAF", "CAD", "KYD", "CLF", "CLP", "CNY", "COP", "COU", "KMF", "CDF", "NZD", "CRC", "CUC", "CUP", "ANG", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "ETB", "FKP", "FJD", "XPF", "GMD", "GEL", "GHS", "GIP", "GTQ", "GBP", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "IDR", "XDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "ZAR", "LRD", "LYD", "CHF", "MOP", "MGA", "MWK", "MYR", "MVR", "MRU", "MUR", "XUA", "MXN", "MXV", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "OMR", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "MKD", "RON", "RUB", "RWF", "SHP", "WST", "STN", "SAR", "RSD", "SCR", "SLE", "SGD", "XSU", "SBD", "SOS", "SSP", "LKR", "SDG", "SRD", "SZL", "SEK", "CHE", "CHW", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "USN", "UYI", "UYU", "UZS", "VUV", "VEF", "VED", "VND", "YER", "ZMW", "ZWL"] }, "lcy_value": { "type": "integer", "minimum": 0 }, "lcy_currency": { "$ref": "#/allOf/0/properties/total/properties/amount_net/properties/currency", "title": "LCY Currency" }, "lcy_decimal_places": { "type": "integer", "minimum": 0, "maximum": 4 } }, "required": ["value", "currency", "lcy_value", "lcy_currency", "decimal_places", "lcy_decimal_places"] }, "amount_gross": { "$ref": "#/allOf/0/properties/total/properties/amount_net", "title": "Amount gross" }, "discount_amount_net": { "$ref": "#/allOf/0/properties/total/properties/amount_net", "title": "Discount Amount Net" }, "discount_amount_gross": { "$ref": "#/allOf/0/properties/total/properties/amount_net", "title": "Discount Amount Gross" }, "discount_amount_percent": { "type": "number", "title": "Discount Amount Percent", "minimum": 0, "maximum": 100 } }, "required": ["amount_net", "amount_gross", "discount_amount_net", "discount_amount_gross", "discount_amount_percent"] }, { "type": "object", "properties": { "sku": { "type": ["string"] }, "linked_style_id": { "type": ["string", "null"] }, "colour_id": { "type": ["string", "null"] }, "style_id": { "type": ["string", "null"] }, "product_id": { "type": ["string", "null"] }, "colour_name": { "type": ["string"] }, "size_name": { "type": ["string"] }, "preorder_date": { "type": ["string", "null"], "format": "date" }, "quantity": { "type": ["integer"], "minimum": 0 }, "unit_price_status": { "type": "string", "enum": ["rrp", "perm", "pos"] }, "returned_quantity": { "type": ["integer"], "minimum": 0 }, "unit_price_net": { "$ref": "#/allOf/0/properties/total/properties/amount_net" }, "unit_price_gross": { "$ref": "#/allOf/0/properties/total/properties/amount_net" }, "discount_code": { "type": ["string", "null"] }, "discount_campaign": { "type": ["string", "null"] }, "cost_net": { "$ref": "#/allOf/0/properties/total/properties/amount_net" }, "order_line_no": { "type": ["integer", "null"] } }, "required": ["sku", "colour_id", "style_id", "quantity", "unit_price_net", "unit_price_gross", "unit_price_status"] }] }, "example": [{ "sku": "PROD004-4001-14", "colour_id": "4001", "style_id": "PROD004", "product_id": "PROD004-4001", "quantity": 1, "returned_quantity": 0, "unit_price_net": { "currency": "GBP", "value": 6584, "decimal_places": 2, "lcy_value": 6584, "lcy_currency": "GBP", "lcy_decimal_places": 2 }, "unit_price_gross": { "currency": "GBP", "value": 7900, "decimal_places": 2, "lcy_value": 7900, "lcy_currency": "GBP", "lcy_decimal_places": 2 }, "unit_price_status": "perm" }] }, "total": { "$ref": "#/allOf/0/properties/items/items/allOf/0" }, "return_total": { "$ref": "#/allOf/0/properties/items/items/allOf/0" }, "net_total": { "$ref": "#/allOf/0/properties/items/items/allOf/0" }, "shipping_method": { "type": ["string", "null"] } }, "required": ["erp_order_id", "status", "ordered_at", "items", "total"] }, { "type": "object", "additionalProperties": false, "properties": { "status": { "type": ["string"], "enum": ["SHIPPED", "PARTIALLY-SHIPPED", "RETURNED", "PARTIALLY-RETURNED", "CANCELLED"] } }, "required": ["erp_order_id", "shipments", "items", "total"] }], "$id": "https://shushed.example.com/messages/order/delivered.schema.json" };
 exports.default = schema;