Deliverect · JSON Structure

Channel Api Post Channelname Order Channellinkid Structure

Deliverect Create / Cancel Order

Type: object Properties: 32 Required: 5
RestaurantDeliveryOnline OrderingPoint-of-SaleOrder ManagementIntegration

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

Properties

channelOrderId channelOrderDisplayId validationId orderType deliveryIsAsap pickupTime deliveryTime placedTime courier ageCheck deliveryAddress deliveryInfo decimalDigits payment taxes taxRemitted items includeCutlery table orderIsAlreadyPaid note numberOfCustomers customer deliveryCost deliveryCostTax serviceCharge serviceChargeTax tip driverTip bagFee discountTotal discounts

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/channel-api-post-channelname-order-channellinkid-structure.json",
  "name": "PostChannelnameOrderChannellinkid",
  "description": "Deliverect Create / Cancel Order",
  "type": "object",
  "properties": {
    "channelOrderId": {
      "type": "string",
      "example": "609a1b2c3d4e5f6a7b8c9d0e",
      "description": "The full unique ID from the ordering channel."
    },
    "channelOrderDisplayId": {
      "type": "string",
      "example": "609a1b2c3d4e5f6a7b8c9d0e",
      "description": "A humanly-readable order reference."
    },
    "validationId": {
      "type": "string",
      "example": "609a1b2c3d4e5f6a7b8c9d0e",
      "description": "Validation ID returned from dispatch validation when used."
    },
    "orderType": {
      "type": "int32",
      "example": 1,
      "description": "Order type. Use 1 for pickup, 2 for delivery, 3 for eat-in, and 4 for curbside."
    },
    "deliveryIsAsap": {
      "type": "boolean",
      "example": true
    },
    "pickupTime": {
      "type": "string",
      "example": "2026-03-15T14:30:00Z"
    },
    "deliveryTime": {
      "type": "string",
      "example": "2026-03-15T14:30:00Z"
    },
    "placedTime": {
      "type": "string",
      "example": "2026-03-15T14:30:00Z"
    },
    "courier": {
      "type": "string",
      "example": "string",
      "description": "Who delivers the order."
    },
    "ageCheck": {
      "type": "boolean",
      "example": true
    },
    "deliveryAddress": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "example": "string"
        },
        "streetNumber": {
          "type": "string",
          "example": "string"
        },
        "postalCode": {
          "type": "string",
          "example": "string"
        },
        "area": {
          "type": "string",
          "example": "string"
        },
        "city": {
          "type": "string",
          "example": "string"
        },
        "country": {
          "type": "string",
          "example": "BE"
        },
        "extraAddressInfo": {
          "type": "string",
          "example": "string"
        },
        "coordinates": {
          "type": "object",
          "properties": {
            "latitude": {
              "type": "float",
              "example": 1.0
            },
            "longitude": {
              "type": "float",
              "example": 1.0
            }
          }
        },
        "verification": {
          "type": "object",
          "properties": {
            "pincode": {
              "type": "string",
              "example": "string"
            }
          }
        }
      }
    },
    "deliveryInfo": {
      "type": "object",
      "properties": {
        "packageSize": {
          "type": "string",
          "example": "string"
        },
        "transportType": {
          "type": "string",
          "example": "string"
        }
      }
    },
    "decimalDigits": {
      "type": "int32",
      "example": 1
    },
    "payment": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "int32",
          "example": 1250
        },
        "type": {
          "type": "int32",
          "example": 1
        },
        "due": {
          "type": "int32",
          "example": 1
        }
      },
      "required": [
        "amount",
        "type"
      ]
    },
    "taxes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "taxClassId": {
            "type": "int32",
            "example": 1
          },
          "name": {
            "type": "string",
            "example": "Deliverect's Pizza Place"
          },
          "total": {
            "type": "int32",
            "example": 1250
          }
        }
      }
    },
    "taxRemitted": {
      "type": "int32",
      "example": 1
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "plu": {
            "type": "string",
            "example": "PIE1"
          },
          "name": {
            "type": "string",
            "example": "Deliverect's Pizza Place"
          },
          "price": {
            "type": "int32",
            "example": 1250
          },
          "quantity": {
            "type": "int32",
            "example": 1
          },
          "remark": {
            "type": "string",
            "example": "No salad"
          },
          "discountReferenceIds": {
            "type": "array",
            "items": {
              "type": "int32",
              "example": 1
            }
          },
          "subItems": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "plu": {
                  "type": "string",
                  "example": "PIE1"
                },
                "name": {
                  "type": "string",
                  "example": "Deliverect's Pizza Place"
                },
                "price": {
                  "type": "int32",
                  "example": 1250
                },
                "quantity": {
                  "type": "int32",
                  "example": 1
                },
                "remark": {
                  "type": "string",
                  "example": "No salad"
                },
                "subItems": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "plu": {
                        "type": "string",
                        "example": "PIE1"
                      },
                      "name": {
                        "type": "string",
                        "example": "Deliverect's Pizza Place"
                      },
                      "price": {
                        "type": "int32",
                        "example": 1250
                      },
                      "quantity": {
                        "type": "int32",
                        "example": 1
                      },
                      "remark": {
                        "type": "string",
                        "example": "No salad"
                      },
                      "subItems": {
                        "type": "array",
                        "items": {
                          "type": "object"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "includeCutlery": {
      "type": "boolean",
      "example": true
    },
    "table": {
      "type": "string",
      "example": "string"
    },
    "orderIsAlreadyPaid": {
      "type": "boolean",
      "example": true
    },
    "note": {
      "type": "string",
      "example": "No salad"
    },
    "numberOfCustomers": {
      "type": "int32",
      "example": 1
    },
    "customer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Deliverect's Pizza Place"
        },
        "companyName": {
          "type": "string",
          "example": "Deliverect's Pizza Place"
        },
        "phoneNumber": {
          "type": "string",
          "example": "+15555550123"
        },
        "phoneAccessCode": {
          "type": "string",
          "example": "+15555550123"
        },
        "email": {
          "type": "string",
          "example": "customer@example.com"
        },
        "tin": {
          "type": "string",
          "example": "string"
        },
        "note": {
          "type": "string",
          "example": "No salad"
        }
      }
    },
    "deliveryCost": {
      "type": "int32",
      "example": 1250
    },
    "deliveryCostTax": {
      "type": "int32",
      "example": 1250
    },
    "serviceCharge": {
      "type": "int32",
      "example": 1
    },
    "serviceChargeTax": {
      "type": "int32",
      "example": 1
    },
    "tip": {
      "type": "int32",
      "example": 1250
    },
    "driverTip": {
      "type": "int32",
      "example": 1250
    },
    "bagFee": {
      "type": "int32",
      "example": 1250
    },
    "discountTotal": {
      "type": "int32",
      "example": 1250
    },
    "discounts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "string"
          },
          "provider": {
            "type": "string",
            "example": "string"
          },
          "name": {
            "type": "string",
            "example": "Deliverect's Pizza Place"
          },
          "channelDiscountCode": {
            "type": "string",
            "example": "string"
          },
          "referenceId": {
            "type": "int32",
            "example": 1
          },
          "value": {
            "type": "int32",
            "example": 1
          },
          "amount": {
            "type": "int32",
            "example": 1250
          }
        }
      }
    }
  },
  "required": [
    "channelOrderId",
    "channelOrderDisplayId",
    "orderType",
    "courier",
    "payment"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/channel-api-post-channelname-order-channellinkid-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.