sets the proportion of the total cost of goods which is given to the merchant. If this is not provided, it will default to the value in the partner contract. On updates, if this is missing, the existing merchant_commission_rate will be used. This field is only used as part of order create and update requests.
order_lines must have at least one OrderLineItem or OrderLineBooking or OrderLineMedicalCompliant.
order_lines must have at least one OrderLineTax ($0 amount is okay for states, cities, etc. with no tax). We are requiring tax lines (even for $0) to be explicit that Yelp doesn't handle tax (yet), and the partner is responsible for specifying it.
order_lines must total to $0 or greater
partner_business_id must map to a yelp_business_id, which we determined when they uploaded their business feed to us via Data Ingestion API
merchant_commission_rate is enabled on a per partner basis at this time.
A line for specifying misc adjustments e.g. discounts, delivery fee, etc.
OrderLine is polymorphic instead of Order
OrderLine loosely corresponds to lines you would see on customer receipt or invoice and its structure depends on the partner. More information can be placed in description or can be split out into another OrderLine.
OrderLineTax, OrderLineAdjustment, OrderLineTip
If OrderLineAdjustment is used for specifying service fee, Please prefix while specifying name property. For example, "Yelp Test" partner would provide name as "Yelp Test Service Fee".
one of OrderLineTax, OrderLineAdjustment, OrderLineTip
price for reservation (could be negative). This is total value of the service. At the service time, the customer is expected to pay (price - upfront_price)
partner’s unique id for what’s being purchased with this OrderLine
start datetime of reservation
(optional) end datetime of reservation
(optional) polymorphic object
number of items being reserved
quantity must be >= 1 for all types
price is required for all types but may be 0
In cases where cancellation_policy object is missing, Yelp assumes that there is no cancellation policy to enforce, and the user can cancel an appointment without any penalty up to the start of the appointment.
object type, value: Address
address line 1
(optional) address line 2
(optional) address line 3
city / district / town / village
state (US) or region
country code (ISO 3166-1 alpha 2)
currency amount with exact precision; number of decimal places should follow ISO 4217
3-char code ISO 4217
amount must be above -10,000,000 and below 10,000,000.
This is provided as an availablity_constraint of Opportunity
This /cancel call would be in response to AWAITING_CANCEL_POLICY_RESOLUTION, which the case where a user initiated a cancel on the yelp, yelp notified the partner of user’s intent, and now yelp is waiting for the partner to call /cancels with an appropriate cancellation_fee and bring the order to one of the cancelled states. Yelp Platform Action: fully refund the order and set it to CANCELLED or CANCELLED_WITH_FEE state.
Administrative cancelled by partner. In this case, cancellation_fee should not be present in the POST request body. Yelp Platform Action: fully refund the order and set it to CANCELLED state.
Business has reported to the partner that the customer was not at the appointment. cancellation_fee contains the penalty that business wishes to charge the customer. YTP Action: charge the user the cancellation_fee, and set the order to CANCELLED or CANCELLED_WITH_FEE as appropriate.
Customer contacted the business and cancelled the appointment. cancellation_fee contains the penalty that business wishes to charge the customer. If customer cancels in time when and no penalty applies, cancellation_fee should be $0. YTP Action: charge the user the cancellation_fee, and set the order to CANCELLED or CANCELLED_WITH_FEE as appropriate.
This is an order cancelled by Yelp, most likely because a customer contacted Yelp requesting a cancel / disputing an order.