DigitalOrderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woolworths-group/main/json-schema/woolworths-group-digital-order-request-schema.json",
  "title": "DigitalOrderRequest",
  "description": "The JSON request structure of the Order endpoint.",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/woolworths-group-wpay-gift-card-partner-openapi.yml#/components/schemas/DigitalOrderRequest",
  "required": [
    "payments",
    "products",
    "refno",
    "syncOnly",
    "deliveryMode"
  ],
  "type": "object",
  "properties": {
    "payments": {
      "$ref": "#/$defs/paymentsObject"
    },
    "products": {
      "description": "The details of the gift card(s) that you wish to order.",
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/cardPurchaseObject"
      }
    },
    "refno": {
      "type": "string",
      "description": "A unique order reference identifier you generate and supply. This identifier is used in the batch order process when retreiving order status. It is also used in real-time orders during the error recovery process.",
      "maxLength": 55
    },
    "syncOnly": {
      "type": "boolean",
      "description": "Indicates if the order shall be processed in real-time or in batch mode. Supply `true` to process in real-time. Supply `false` to process as a batch. Note, there is a 10 card limit on real-time orders. Consult the usage guide for information about these two order types and the type-specific sequence of events."
    },
    "deliveryMode": {
      "type": "string",
      "description": "This field is used to specify how the gift card details will be delivered. Only ‘API’ is supported.",
      "default": "API",
      "enum": [
        "API"
      ]
    }
  },
  "$defs": {
    "cardPurchaseObject": {
      "type": "object",
      "required": [
        "sku",
        "price",
        "qty",
        "currency"
      ],
      "properties": {
        "sku": {
          "type": "string",
          "description": "The gift card identifier (SKU). The list of gift cards you may order will be predefined and shared during the onboarding process."
        },
        "price": {
          "type": "number",
          "description": "The currency amount to load onto the gift card."
        },
        "qty": {
          "type": "number",
          "description": "The number of gift cards you wish to order with this SKU and price combination."
        },
        "currency": {
          "type": "string",
          "description": "Use 036 for AUD currency. The full list of valid codes is defined at  https://en.wikipedia.org/wiki/ISO_4217",
          "minLength": 3,
          "maxLength": 3
        }
      }
    },
    "paymentsObject": {
      "description": "The account the gift card amounts will be deducted from. Requires one single element to indicate the payment will be made using the SVA.",
      "type": "array",
      "minItems": 1,
      "maxItems": 1,
      "items": {
        "required": [
          "code",
          "amount"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Always use the code 'svc'.",
            "default": "svc",
            "enum": [
              "svc"
            ]
          },
          "amount": {
            "type": "number",
            "description": "The payment amount for the order. This value must match the sum of 'price' times 'qty' for all cards in this order."
          }
        }
      }
    }
  }
}