Skip to content

Order Creation Flow - Migration to Order Total V2

OrderTotal object containing financial payload for Order is being discontinued, and a new object OrderTotalV2 is taking its place. This new object provides better breakdown of financial values.

OrderTotalV2 properties - customerTotal Customer total breakdown: food sales, service fee, tip for restaurant/driver, etc.. Allows ingestion of composite values. Example: "foodSales": { "breakdown": [ { "subType": "VALUE", "name": "Hamburger", "value": 3.40 }, { "subType": "VAT", "name": "food sales VAT", "value": 0.6 } ] }

  • customerPayment Customer payment details (payment, prepayment, amount to return, etc..)
  • serviceProviderCharge Breakdown of service provider charges. Allows ingestion of composite values
  • payout Breakdown of the payout.

Guidelines

  • one of orderTotal or orderTotalV2 must be set in Order object
  • Instead of sending VALUE_WITH_TAX send two separate lines for VALUE and TAX accordingly. Only use VALUE_WITH_TAX when breakdown is unknown.
  • Do not send duplicate values, customer total calculated as a sum of all fields of customerTotal except those marked as VAT