v1

latestOpenAPI 3.1.02026-07-2413054.9 KB

Insert Order

post/orders

Headers

Authorizationstring

Replace the BgxsDwd00n.LNNn90QydrjgZ1K9dS13 part with your own API_KEY from Shipday for authentication.

Content-Typestring

Request body

orderNumberstring required

Alphanumeric identifier for the order object

customerNamestring required

The name of the customer

customerAddressstring required

Address of the customer

customerEmailstring

Email Address of the customer

customerPhoneNumberstring required

Phone number of the customer with country code

restaurantNamestring required

Name of the restaurant

restaurantAddressstring required

Address of the restaurant

restaurantPhoneNumberstring

Phone number of the restaurant with country code

expectedDeliveryDatestring date

Expected delivery date in UTC for the particular order ( yyyy-mm-dd format)

expectedPickupTimestring date-time

Expected pickup time in UTC for the particular order (format hh:mm:ss)

expectedDeliveryTimestring date-time

Expected Delivery Time in UTC for the particular order (format hh:mm:ss)

pickupLatitudenumber double

Pickup location latitude

pickupLongitudenumber double

Pickup location longitude

deliveryLatitudenumber double

Delivery location latitude

deliveryLongitudenumber double

Delivery location longitude

tipsnumber double

Tips amount for the order

taxnumber double

Tax amount for the order

discountAmountnumber double

Discount amount for the order

deliveryFeenumber double

Delivery fee amount for the order

totalOrderCostnumber double

Total cost for the particular order

pickupInstructionstring

Pickup related instructions for the order

deliveryInstructionstring

Delivery Instruction for the driver or restaurant (if given)

orderSourcestring

Source of the order

additionalIdstring

Additional ID for the order

clientRestaurantIdinteger

Client Restaurant ID

paymentMethodstring

Selected payment method for the order

creditCardType'VISA' | 'MASTER_CARD' | 'AMEX' | 'OTHER'

Type of the credit card ( Not needed if the payment method is 'cash' )

creditCardIdinteger

Last four digits of the credit card ( Not needed if the payment method is 'cash' )

isCateringboolean

Marker of catering order

Response

200

successboolean

orderIdinteger

Example response

{
  "success": true,
  "orderId": 118
}