Deliverect · JSON Structure

Commerce Api Post Commerce Account Id Checkouts 1 Structure

Deliverect Checkout Basket

Type: object Properties: 4 Required: 2
RestaurantDeliveryOnline OrderingPoint of SaleOrder ManagementIntegration

PostCommerceAccountIdCheckouts1 is a JSON Structure definition published by Deliverect, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

basket note payments order

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/deliverect/refs/heads/main/json-structure/commerce-api-post-commerce-account-id-checkouts-1-structure.json",
  "name": "PostCommerceAccountIdCheckouts1",
  "description": "Deliverect Checkout Basket",
  "type": "object",
  "properties": {
    "basket": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "example": "609a1b2c3d4e5f6a7b8c9d0e"
        }
      },
      "required": [
        "id"
      ]
    },
    "note": {
      "type": "string",
      "example": "No salad"
    },
    "payments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "dpay",
              "third_party",
              "gift_card"
            ],
            "default": "dpay",
            "example": "dpay"
          },
          "externalId": {
            "type": "string",
            "default": "",
            "example": "609a1b2c3d4e5f6a7b8c9d0e",
            "description": "id of the payment provider"
          },
          "isPrepaid": {
            "type": "boolean",
            "default": "true",
            "example": "true",
            "description": "indicates whether the order has been paid. For Dpay it should be true."
          },
          "amount": {
            "type": "int32",
            "default": "",
            "example": 1250,
            "description": "total amount paid with 2 decimal digits. 800 would correspond to 8 in local currency"
          },
          "metadata": {
            "type": "object",
            "properties": {}
          }
        },
        "required": [
          "type",
          "externalId",
          "isPrepaid",
          "amount"
        ]
      }
    },
    "order": {
      "type": "object",
      "properties": {
        "channelOrderId": {
          "type": "string",
          "example": "609a1b2c3d4e5f6a7b8c9d0e",
          "description": "The full unique ID from the ordering channel, cannot be reused within 48hr after pickup (across all accounts)"
        },
        "channelOrderDisplayId": {
          "type": "string",
          "example": "609a1b2c3d4e5f6a7b8c9d0e",
          "description": "A more human\u2011readable order reference to provide, usually shorter than the channelOrderId"
        },
        "validationId": {
          "type": "string",
          "example": "609a1b2c3d4e5f6a7b8c9d0e"
        },
        "courier": {
          "type": "string",
          "example": "string"
        }
      }
    }
  },
  "required": [
    "basket",
    "payments"
  ]
}