Create Order

Parameters should be considered in Order Creation process

Order Creation Process

In order to create an Order, there are some aspects that should be taken into consideration. These aspects are listed in the following API

Create Order

POST env./api/{api-version}/Order/create

This endpoint allows you to patch your order onto SHGARDI's

Path Parameters

Name	Type	Description
api-version	string	The API version is "1"

Headers

Name	Type	Description
Accept-Language	string	The default language is "en-US"

Request Body

Name	Type	Description
orderItems	array	{ "name": "string", "quantity": 0, "imageURL": "string", "price": 0, "note": "string" }
extraStoreFee	number	The Partner's Commission separated to be added to his wallet
payOrderCashToStore	boolean	In case of "TRUE" the Courier will Pickup the Order and pay for it, and will collect the Order Price from the Customer, by delivering it.
DeliveryFeeIncludeInPrice	boolean	Represents whether the Total Order price including the delivery fees. The default value at Shgardi's is "false"
consignmentNo	string	The Shipment number constrained by char length 2-20
pickupDate	string	The date and time of the Order pick-up by the Driver from the store. It has to be after the current timing. The parameter format "yyyy-MM-ddTHH:mm:ss.fffZ", UTC datetime.
deliveryDate	string	The date and time of the delivery by the Driver to the Customer. It has to be after the Pick-up time. The parameter format "yyyy-MM-ddTHH:mm:ss.fffZ", UTC datetime.
customerOrderNo	string	The Order number retrieved from the Partner's side
noOfPieces	string	Number of the Order Pieces
weightKg	number	Weight of the Order by Kilograms
paymentMethod	string	The payment method of the Partner whether it is; Cash On Delivery, valued "1", or already paid, valued "7"
dimensionsCm	string	The dimensions of the Order
orderDescription	string	The description of the Order contents
recipientName	string	The name of the customer
recipientMobile	string	The mobile number of the customer. It has to be structured as follows; +[Country Code][Phone Number], however it is only operating in KSA and Egypt
recipientEmail	string	The Email address of the customer
recipientAddress	string	The physical address of the customer
recipientCity	string	The city of the customer's residence
recipientCommunity	string	The district in which the customer lives
recipientFlatFloor	string	The flat floor number in which the customer lives
recipientLatitude	number	The latitude of the physical address of the customer
recipientLongitude	number	The longitude of the physical address of the customer
recipientSplInstructions	string	Notes of the Customer on the Order / Order Delivery
senderName	string	The name of the Order creator (Partner; whoever has the Order items in-house).
senderCode	string	Unique code of each Order creator (Partner; whoever has the Order items in-house)
senderMobile	string	The mobile number of the Order creator (Partner/Agent). It is structured as follows; +[Country Code][Phone Number], however it is only operating in KSA and Egypt.
senderEmail	string	The Email address of the Order creator (Partner/Agent)
senderAddress	string	The physical address of the Order creator (Partner/Agent)
senderLatitude	number	The latitude of the physical address of the Order creator (Partner/Agent)
senderLongitude	number	The longitude of the physical address of the Order creator (Partner/Agent)
senderCity	string	The Order creator city of residence
remarks	string	The notes written on the Orders
price	number	The price of the Order items
deliveryFee	number	The delivery fees paid by the customer to the Partner

200 Order is successfully created.

{
  "orderId": "string"
}

The default value of the parameter "payOrderCashToStore" is "False", which means that the Courier will pickup the order without paying for it, however he/she will collect the order price cash from the customer to be deducted from his/her wallet in the benefit to the Partner

Throughout the Delivery Fees scope, the Create Order API Parameter; "deliveryFee" could directly retrieve its value for each order process as per the Partner's configurations