Create Order API

The Create Order API allows partners to create & submit orders based upon a previously generated Skipcart quote. Once a successful order is received from a partner, Skipcart will create a delivery event for the pickup & dropoff to occur. Create Order is a required API for Skipcart integration.

Create Order Request

JSON

{
	"partner_order_id": "ExampleMerchant12345",
	"order_total": 22.5,
	"tip": 10.5,
	"contains_alcohol": "yes",
	"skipcart_quote_id": "37700",
	"customer_sign": "yes",
	"priority": "",
	"brand_name": "ExampleBrand",
	"merchant": {
		"name": "ExampleMerchant",
		"code": "ExampleMerchant",
		"address": {
			"address1": "101 Woods of Boerne Blvd",
			"address2": "Ste 200",
			"city": "Boerne",
			"state": "TX",
			"zipcode": "78006",
			"phone": "2012673412",
			"phone_prefix": "+1",
			"country_code": "US",
			"latitude": "29.78993630714541",
			"longitude": "-98.70493583463175"
		},
		"notes": [
			{
				"key": "PickupNote",
				"value": "Go to the orange pickup counter when you arrive."
			}
		]
	},
	"customer": {
		"id": "",
		"first_name": "John",
		"last_name": "Smith",
		"phone": "5511884654",
		"email": "[email protected]"
	},
	"delivery_information": {
		"customer": {
			"first_name": "John",
			"last_name": "Smith"
		},
		"address": {
			"fulladdress": "202 W Kronkosky St, Boerne, TX, 78006",
			"address1": "202 W Kronkosky St",
			"address2": "",
			"city": "Boerne",
			"state": "TX",
			"zipcode": "78006",
			"country_code": "US",
			"latitude": "29.78633519394706",
			"longitude": "-98.72929029242228"
		},
		"delivery_window": {
			"start_at": "2021-02-26T09:10:00Z",
			"duration": 60,
			"end_at": "2021-02-26T09:30:00Z"
		},
		"notes": [
			{
				"key": "Dropoff Instructions",
				"value": "Black door near corner of the building. Age Verification Required."
			}
		]
	},
	"status": {
		"name": "new"
	},
	"customer_unavailable_workflow": "2",
	"customer_refused_deliveryWorkflow": "1",
	"contactless_order": "1",
	"order_details": [
		{
			"description": "Cheeseburger",
			"quantity": 1
		},
		{
			"description": "Fries",
			"quantity": 1
		},
		{
			"description": "Coke",
			"quantity": 1
		},
		{
			"description": "Frozen Margarita",
			"quantity": 2
		}
	]
}

❗️

All amounts (order_total / tip) will be passed and returned in USD

❗️

The Skipcart Order ID ("id": "141291") should be retained by the partner system for use in subsequent API calls