@rapharacing/schemas/dist/schemas/order.json

OpenAPI to JSON Schema to be used with middy for CC response validation

{
  "type": "object",
  "properties": {
    "adyenBoletoBarCodeReference": {
      "type": "string"
    },
    "adyenBoletoData": {
      "type": "string"
    },
    "adyenBoletoDueDate": {
      "type": "string",
      "format": "date-time"
    },
    "adyenBoletoExpirationDate": {
      "type": "string",
      "format": "date-time"
    },
    "adyenBoletoUrl": {
      "type": "string"
    },
    "adyenMultibancoAmount": {
      "type": "number"
    },
    "adyenMultibancoDeadline": {
      "type": "string"
    },
    "adyenMultibancoEntity": {
      "type": "string"
    },
    "adyenMultibancoReference": {
      "type": "string"
    },
    "adyenPosReceipt": {
      "type": "string"
    },
    "appliedOrderPromotions": {
      "type": "array",
      "description": "List of applied order promotions",
      "items": {
        "$ref": "_definitions.json#/definitions/PromotionResult",
        "originalRef": "PromotionResult"
      }
    },
    "appliedProductPromotions": {
      "type": "array",
      "description": "List of applied product promotions",
      "items": {
        "$ref": "_definitions.json#/definitions/PromotionResult",
        "originalRef": "PromotionResult"
      }
    },
    "appliedVouchers": {
      "type": "array",
      "description": "List of applied vouchers",
      "items": {
        "$ref": "_definitions.json#/definitions/Voucher",
        "originalRef": "Voucher"
      }
    },
    "calculated": {
      "type": "boolean",
      "description": "Flag showing if order is calculated"
    },
    "cancellable": {
      "type": "boolean",
      "example": true,
      "description": "Boolean flag showing if order is cancellable"
    },
    "code": {
      "type": "string",
      "description": "Code number of order"
    },
    "consignments": {
      "type": "array",
      "description": "List of consignment",
      "items": {
        "$ref": "_definitions.json#/definitions/Consignment",
        "originalRef": "Consignment"
      }
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Date of order creation"
    },
    "deliveryAddress": {
      "description": "Delivery address",
      "$ref": "_definitions.json#/definitions/Address",
      "originalRef": "Address"
    },
    "deliveryCost": {
      "description": "Delivery cost",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "deliveryItemsQuantity": {
      "type": "integer",
      "format": "int64",
      "description": "Quantity of delivery items"
    },
    "deliveryMode": {
      "description": "Delivery mode information",
      "$ref": "_definitions.json#/definitions/DeliveryMode",
      "originalRef": "DeliveryMode"
    },
    "deliveryOrderGroups": {
      "type": "array",
      "description": "List of delivery order entries group",
      "items": {
        "$ref": "_definitions.json#/definitions/DeliveryOrderEntryGroup",
        "originalRef": "DeliveryOrderEntryGroup"
      }
    },
    "deliveryStatus": {
      "type": "string",
      "description": "Order delivery status"
    },
    "deliveryStatusDisplay": {
      "type": "string",
      "description": "Order delivery status display"
    },
    "entries": {
      "type": "array",
      "description": "List of order entries",
      "items": {
        "$ref": "_definitions.json#/definitions/OrderEntry",
        "originalRef": "OrderEntry"
      }
    },
    "entryGroups": {
      "type": "array",
      "description": "List of entry groups",
      "items": {
        "$ref": "_definitions.json#/definitions/EntryGroup",
        "originalRef": "EntryGroup"
      }
    },
    "guestCustomer": {
      "type": "boolean",
      "description": "Flag showing if customer is Guest customer"
    },
    "guid": {
      "type": "string",
      "description": "Guest user id identifier"
    },
    "net": {
      "type": "boolean",
      "description": "Flag stating iv value is net-value"
    },
    "orderDiscounts": {
      "description": "Order discounts",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "paymentInfo": {
      "description": "Payment information",
      "$ref": "_definitions.json#/definitions/PaymentDetails",
      "originalRef": "PaymentDetails"
    },
    "pickupItemsQuantity": {
      "type": "integer",
      "format": "int64",
      "description": "Quantity of pickup items"
    },
    "pickupOrderGroups": {
      "type": "array",
      "description": "List of pickup order entry group",
      "items": {
        "$ref": "_definitions.json#/definitions/PickupOrderEntryGroup",
        "originalRef": "PickupOrderEntryGroup"
      }
    },
    "productDiscounts": {
      "description": "Product discounts",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "returnable": {
      "type": "boolean",
      "example": true,
      "description": "Boolean flag showing if order is returnable"
    },
    "site": {
      "type": "string",
      "description": "Site"
    },
    "status": {
      "type": "string",
      "description": "Status of order"
    },
    "statusDisplay": {
      "type": "string",
      "description": "Status display"
    },
    "store": {
      "type": "string",
      "description": "Store"
    },
    "subTotal": {
      "description": "Subtotal price",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "totalDiscounts": {
      "description": "Total discounts",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "totalItems": {
      "type": "integer",
      "format": "int32"
    },
    "totalPrice": {
      "description": "Total price value",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "totalPriceWithTax": {
      "description": "Total price with tax",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "totalTax": {
      "description": "Total tax price",
      "$ref": "_definitions.json#/definitions/Price",
      "originalRef": "Price"
    },
    "unconsignedEntries": {
      "type": "array",
      "description": "List of unconsigned order entries",
      "items": {
        "$ref": "_definitions.json#/definitions/OrderEntry",
        "originalRef": "OrderEntry"
      }
    },
    "user": {
      "description": "User information",
      "$ref": "_definitions.json#/definitions/Principal",
      "originalRef": "Principal"
    }
  },
  "title": "Order",
  "description": "Representation of an Order",
  "$schema": "http://json-schema.org/schema#"
}