👍
How to use this endpoint

Required parameters are listed below. For the full list of properties, see About aggregated order info. Merchants using Yotpo Reviews must also add the "first_name" and "last_name" customer parameter.

For example requests of full and minimal payload, see below.

Example requests

{
	"purchase": {
		"external_order_id": "string",
		"order_date": "2021-03-25T13:57:05Z",
		"checkout_token": "string",
		"payment_method": "string",
		"currency": "string",
		"total_price": 20,
		"subtotal_price": 10,
		"landing_site_url": "string",
		"payment_status": "string",
		"cancellation": {
			"cancellation_date": "2021-03-28T13:35:57Z"
		},
		"customer": {
			"external_id": "2sadfasdf",
			"first_name": "string",
			"last_name": "string",
			"email": "string",
			"phone_number": "string",
			"custom_properties": {
				"key1": "value1",
				"key2": "value2"
			},
			"accepts_sms_marketing": true,
			"accepts_email_marketing": true
		},
		"billing_address": {
			"address1": "string",
			"address2": "string",
			"city": "string",
			"company": "string",
			"state": "string",
			"zip": "string",
			"province_code": "string",
			"country_code": "string",
			"phone_number": "string"
		},
		"shipping_address": {
			"address1": "string",
			"address2": "string",
			"city": "string",
			"company": "string",
			"state": "string",
			"zip": "string",
			"province_code": "string",
			"country_code": "string",
			"phone_number": "string"
		},
		"line_items": [{
			"quantity": 0,
			"total_price": 0,
			"subtotal_price": 0,
			"coupon_code": "string",
			"custom_properties": {
				"key1": "value1",
				"key2": "value2"
			},
			"product": {
				"external_id": "string",
				"name": "string",
				"description": "string",
				"url": "string",
				"price": 0,
				"currency": "string",
				"inventory_quantity": 0,
				"is_discontinued": true,
				"group_name": "string",
				"image_url": "string",
				"mpn": "string",
				"brand": "string",
				"sku": "string",
				"gtins": [{
					"declared_type": "string",
					"value": "string"
				}]
			}
		}],
		"fulfillments": [{
			"external_id": "string",
			"fulfillment_date": "2021-03-31T11:58:51Z",
			"status": "pending",
			"shipment_info": {
				"shipment_status": "label_printed",
				"tracking_company": "string",
				"tracking_url": "string",
				"tracking_number": "string"
			},
			"fulfilled_items": [{
				"external_product_id": "string",
				"quantity": 0
			}]
		}],
		"custom_properties": {
			"key1": "value1",
			"key2": "value2"
		}
	}
}

{
   "purchase":{
      "external_order_id":"000000005",
      "order_date":"2021-03-25T13:57:05Z",
      "customer":{
         "external_id":"2sadfasdf"
      },
      "line_items":[
         {
            "product":{
               "external_id":"0000007",
               "name":"0000007"
            },
            "quantity":1
         }
      ]
   }
}

200200

400400