POST pos/order/complete

Authorized only.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
CompanyId	integer	None.
OrderTypeId	integer	None.
CustomerId	integer	None.
ExternalDeliveryProvider	string	None.
Hash	string	None.
ItemsHash	string	None.
Items	Collection of ShoppingCartItem	None.
Discount	ShoppingCartDiscount	None.
Discounts	Collection of ShoppingCartDiscount	None.
Tips	ShoppingCartTips	None.
Loyalty	ShoppingCartLoyalty	None.
RewardPointsRedeemption	decimal number	None.
RewardPointsRedeemptionMoney	decimal number	None.
PaymentInfo	ShoppingCartPayment	None.
Totals	ShoppingCartTotals	None.
DeliveryInfo	ShoppingCartDeliveryInfo	None.
VendorValidation	ShoppingCartVendorsValidation	None.
DesiredReadyTime	date	None.
EstimatedReadyTime	date	None.
Notes	string	None.
OrderTag	string	None.
Rewards	Collection of string	None.
RequireCaptcha	boolean	None.
CharityAmount	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "ce5aade5-f9c5-4abb-9d0e-cdc9856aca0f",
  "CompanyId": 1,
  "OrderTypeId": 1,
  "CustomerId": 1,
  "ExternalDeliveryProvider": "sample string 2",
  "Hash": "sample string 3",
  "ItemsHash": "sample string 4",
  "Items": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "MenuId": 5,
      "MenuName": "sample string 6",
      "BookingId": 1,
      "BookingAddonId": 1,
      "Price": 7.0,
      "Qty": 8.0,
      "SubTotal": 9.0,
      "DiscountTotal": 10.0,
      "RewardPoints": 11.0,
      "TaxTotal": 12.0,
      "Total": 13.0,
      "Taxes": [
        {
          "Amount": 2.0,
          "Name": "sample string 3"
        },
        {
          "Amount": 2.0,
          "Name": "sample string 3"
        }
      ],
      "Modifiers": [
        {
          "ModifierSetId": 1,
          "ModifierSetCode": "sample string 2",
          "ModifierSetName": "sample string 3",
          "ModifierId": 4,
          "ModifierCode": "sample string 5",
          "ModifierName": "sample string 6",
          "Qty": 7.0,
          "Price": 9.0,
          "Total": 10.0,
          "ModifierOption": {
            "Id": 1,
            "Name": "sample string 2",
            "Option": "sample string 3"
          },
          "PizzaSide": 1
        },
        {
          "ModifierSetId": 1,
          "ModifierSetCode": "sample string 2",
          "ModifierSetName": "sample string 3",
          "ModifierId": 4,
          "ModifierCode": "sample string 5",
          "ModifierName": "sample string 6",
          "Qty": 7.0,
          "Price": 9.0,
          "Total": 10.0,
          "ModifierOption": {
            "Id": 1,
            "Name": "sample string 2",
            "Option": "sample string 3"
          },
          "PizzaSide": 1
        }
      ],
      "AplliedDiscounts": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Amount": 5.0,
          "PointCost": 6.0,
          "AutomationType": "None",
          "Code": "sample string 7",
          "ExternalId": "sample string 8"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Amount": 5.0,
          "PointCost": 6.0,
          "AutomationType": "None",
          "Code": "sample string 7",
          "ExternalId": "sample string 8"
        }
      ],
      "SubscriptionId": 1,
      "RecipientEmail": "sample string 20",
      "RecipientName": "sample string 21",
      "Notes": "sample string 22",
      "Bundle": {
        "BundleId": 1,
        "Sku": "sample string 2",
        "BundleGroupId": "46522046-aaba-4617-99c2-9da717be0536"
      },
      "Meal": {
        "MealId": 1,
        "MealGroupId": "aa9c1a4f-8bfe-44f7-a4f7-82e09ad85024"
      },
      "ItemSource": 0,
      "RelatedProductId": 1,
      "TrackInventory": true,
      "Stock": 29.0
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "MenuId": 5,
      "MenuName": "sample string 6",
      "BookingId": 1,
      "BookingAddonId": 1,
      "Price": 7.0,
      "Qty": 8.0,
      "SubTotal": 9.0,
      "DiscountTotal": 10.0,
      "RewardPoints": 11.0,
      "TaxTotal": 12.0,
      "Total": 13.0,
      "Taxes": [
        {
          "Amount": 2.0,
          "Name": "sample string 3"
        },
        {
          "Amount": 2.0,
          "Name": "sample string 3"
        }
      ],
      "Modifiers": [
        {
          "ModifierSetId": 1,
          "ModifierSetCode": "sample string 2",
          "ModifierSetName": "sample string 3",
          "ModifierId": 4,
          "ModifierCode": "sample string 5",
          "ModifierName": "sample string 6",
          "Qty": 7.0,
          "Price": 9.0,
          "Total": 10.0,
          "ModifierOption": {
            "Id": 1,
            "Name": "sample string 2",
            "Option": "sample string 3"
          },
          "PizzaSide": 1
        },
        {
          "ModifierSetId": 1,
          "ModifierSetCode": "sample string 2",
          "ModifierSetName": "sample string 3",
          "ModifierId": 4,
          "ModifierCode": "sample string 5",
          "ModifierName": "sample string 6",
          "Qty": 7.0,
          "Price": 9.0,
          "Total": 10.0,
          "ModifierOption": {
            "Id": 1,
            "Name": "sample string 2",
            "Option": "sample string 3"
          },
          "PizzaSide": 1
        }
      ],
      "AplliedDiscounts": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Amount": 5.0,
          "PointCost": 6.0,
          "AutomationType": "None",
          "Code": "sample string 7",
          "ExternalId": "sample string 8"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Description": "sample string 3",
          "Amount": 5.0,
          "PointCost": 6.0,
          "AutomationType": "None",
          "Code": "sample string 7",
          "ExternalId": "sample string 8"
        }
      ],
      "SubscriptionId": 1,
      "RecipientEmail": "sample string 20",
      "RecipientName": "sample string 21",
      "Notes": "sample string 22",
      "Bundle": {
        "BundleId": 1,
        "Sku": "sample string 2",
        "BundleGroupId": "46522046-aaba-4617-99c2-9da717be0536"
      },
      "Meal": {
        "MealId": 1,
        "MealGroupId": "aa9c1a4f-8bfe-44f7-a4f7-82e09ad85024"
      },
      "ItemSource": 0,
      "RelatedProductId": 1,
      "TrackInventory": true,
      "Stock": 29.0
    }
  ],
  "Discount": {
    "Code": "sample string 1",
    "ExternalId": "sample string 2"
  },
  "Discounts": [
    {
      "Code": "sample string 1",
      "ExternalId": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "ExternalId": "sample string 2"
    }
  ],
  "Tips": {
    "Amount": 1.0,
    "IsPercentage": true
  },
  "Loyalty": {
    "MinimalRedemableAmount": 1.0,
    "MinimalRedemableAmountMoney": 2.0,
    "MaximumRedeemableAmount": 3.0,
    "MaximumRedeemableAmountMoney": 4.0,
    "AvailableRewardPoints": 5.0,
    "AvailableRewardPointsMoney": 6.0,
    "RedemptionType": "paymentTender"
  },
  "RewardPointsRedeemption": 1.0,
  "RewardPointsRedeemptionMoney": 1.0,
  "PaymentInfo": {
    "PaymentMethod": "sample string 1",
    "Data": "sample string 2"
  },
  "Totals": {
    "SubTotal": 1.0,
    "DiscountTotal": 2.0,
    "RewardPoints": 3.0,
    "TaxTotal": 4.0,
    "TipsTotal": 5.0,
    "OrderTypeFee": 6.0,
    "CharityAmount": 7.0,
    "DepositAmount": 8.0,
    "Total": 10.0,
    "Taxes": [
      {
        "Amount": 2.0,
        "Name": "sample string 3"
      },
      {
        "Amount": 2.0,
        "Name": "sample string 3"
      }
    ]
  },
  "DeliveryInfo": {
    "AddressId": 1,
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "Address": "sample string 5",
    "Address2": "sample string 6",
    "City": "sample string 7",
    "Zip": "sample string 8",
    "State": {
      "Id": 1,
      "Name": "sample string 1",
      "Abbreviation": "sample string 2",
      "CountryId": 1
    },
    "Country": {
      "Id": 1,
      "Name": "sample string 1",
      "Abbreviation": "sample string 2",
      "CountryId": 1
    },
    "BusinessName": "sample string 9",
    "BusinessDelivery": true,
    "PhoneAuthenticationToken": "sample string 11",
    "PhoneAuthCode": "sample string 12",
    "PickupLocationId": 1,
    "Latitude": 1.1,
    "Longitude": 1.1,
    "SelectedShippingMethod": {
      "CompanyId": 1,
      "ShipmentId": "sample string 2",
      "RateId": "sample string 3",
      "AdditionalAmount": 4.0,
      "Amount": 5.0,
      "CarrierName": "sample string 6",
      "CarrierCode": "sample string 7",
      "ServiceCode": "sample string 8"
    }
  },
  "VendorValidation": {
    "AllowOrder": true,
    "Vendors": [
      {
        "VendorName": "sample string 1",
        "MinimalOrderAmount": 2.0,
        "MinimalOrderAmountForFreeShipping": 3.0,
        "Error": "sample string 4"
      },
      {
        "VendorName": "sample string 1",
        "MinimalOrderAmount": 2.0,
        "MinimalOrderAmountForFreeShipping": 3.0,
        "Error": "sample string 4"
      }
    ]
  },
  "DesiredReadyTime": "2025-11-05T00:13:44.8117687-05:00",
  "EstimatedReadyTime": "2025-11-05T00:13:44.8117687-05:00",
  "Notes": "sample string 7",
  "OrderTag": "sample string 8",
  "Rewards": [
    "sample string 1",
    "sample string 2"
  ],
  "RequireCaptcha": true,
  "CharityAmount": 10.0
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.

POST pos/order/complete

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml

text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

URI parameters

Headers | Add header

Body

Status

Headers

Body