Create Order API

post https://stageapi.skipcart.com/v1api/Order

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

{
	"partner_order_id": "ExampleMerchant12345",
	"agg_order_id": "Example12345",
	"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": "john.smith@gmail.com"
	},
	"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

Body Params

partner_order_id

string

(Required) partner_order_id needs to be unique for each transaction. If the partner_order_id already exists in Skipcart systems and you try to place an order with the same partner_order_id, the API will return an HTTP status 409 and the complete order object from the existing Order ID in Skipcart.

agg_order_id

string

(Optional) Aggregate Order ID for aggregators

order_total

string

(Required) Order total amount. Passing this is highly encouraged as driver can validate the order at pickup. All amounts should be passed in dollars. A numeric value must be passed in this field; null is not a valid input.

tip

string

(Required) Tip included in original order to be passed onto driver. All amounts should be passed in dollars. A numeric value must be passed in this field; null is not a valid input.

contains_alcohol

string

Defaults to "yes" or ""

(Optional) If order contains alcohol or not.

skipcart_quote_id

string

(Requirement Dependent) If partner is quote based, this is a required parameter as all quote-based partners must reference an existing quote when creating an order

customer_sign

string

Defaults to "yes" or ""

(Optional) If "yes" signature will be requested from customer. Requiring a customer signature, or not, is something which can be defaulted for the partner. Including this field in the request will always override the partner default setting.

priority

string

Defaults to "urgent" or ""

(Optional) If urgent, system will attempt to schedule a delivery immediately. This should only be used for orders with extremely short lead times.

brand_name

string

(Required) Name of store which is passed to driver for pickup location

merchant/name

string

(Required) Name of merchant. May be the same as brand_name.

merchant/code

string

(Required) Each Partner is given a merchant_code in Skipcart. The merchant code will be provided as part of the sandbox API credentials.

merchant/address

string

(Required) Valid US address is required. If passing Skipcart Quote ID, the address must match what was provided in the quote.

merchant/address/longitude

string

(Optional) The merchant's pickup location longitude. Providing latitude & longitude improves driver pickup accuracy especially when there are designated pickup spots.

merchant/address/latitude

string

(Optional) The merchant's pickup location latitude. Providing latitude & longitude improves driver pickup accuracy especially when there are designated pickup spots.

notes (Object)

string

(Optional) Notes provide additional opportunity to pass information to driver. Good pickup and dropoff notes ensure a successful delivery. All notes are optional.

customer (Object)

string

(Required) All fields required except customer email is optional

delivery_information/customer

string

(Required) Contains customer first and last name

fulladdress

string

(Optional) Valid US full address with the format like address1, address2, city, state, zip

delivery_information/address

string

(Required) Valid US address is required. If passing Skipcart Quote ID, the address must match what was provided in the quote.

delivery_information/delivery_window

string

(Required) Valid Date/Time - UTC Format required. Should be an exact match to the times returned in the Quote API response (estimated_pickup_time / estimated_dropoff_time)

delivery_information/address/latitude

string

(Optional) Specifying latitude & longitude improves driver dropoff accuracy

delivery_information/address/longitude

string

(Optional) Specifying latitude & longitude improves driver dropoff accuracy

status

string

Defaults to "new"

(Required) Represents status of the order

customer_unavailable_workflow

string

(Optional) Skipcart will default to the partner configured settings but these attributes can be used to override default partner settings. See Special Order Circumstances below.

customer_refused_delivery

string

(Optional) (Optional) Skipcart will default to the partner configured settings but these attributes can be used to override default partner settings. See Special Order Circumstances below.

contactless_order

string

(Optional) Indicates whether the order should be delivered in a contactless manner with the customer. Though this is currently optional, due to COVID, we are encouraging drivers to deliver contactless.

order_details

string

(Optional) Allows the driver to see the individual line items associated with the order to ensure more successful driver pickups.

Headers

UserToken

string

The UserToken is retrieved every 24 hours and is a security mechanism which must be used to interface with various Skipcart APIs

AppToken

string

The AppToken is the unique partner identifier and must be included in every Skipcart API request

Content-Type

string

application/json

Create Order API

Create Order Request

❗️
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

Create Order Request

❗️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

❗️
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