Orders


When a Consumer marks Cart Item (Cart ID) ready for checkout, it will orders and invoice. An Order is a commercial document issued by the Marketplace to the Merchant and Consumer. It recorded the sale transaction and indicates the items, services, quantities, agreed price for the items or services that Merchant has to fulfill. An Invoice is an aggregated view of all the items/services the Consumer has purchased within a single checkout. Even though, in our default Spacetime template only have a single checkout process, you are still able to create a cart and do multi-items checkout. If you wish to follow our default Spacetime template whereby you want to allow single item checkout, you will still have to insert the item into a backend cart and set the item ready for checkout. You will receive both an invoice and order ID.


If you allow Consumer to purchase items from multiple Merchants in a single checkout. This will create an Invoice ID for the Consumer’s reference, to see the full list of items they have bought within that checkout. In the backend, the checkout will breakup the items into separate Order IDs for each Merchant to fulfill respectively. In each Order ID, the Merchants are only able to see items/services related to them and also the breakdown of total item price less the commission to be paid to the Admin. This is for privacy purposes as a Marketplace will not want Merchants to know what Consumers ordered from other Merchants.

A Transaction ID is a unique string that is given by any payment gateway to identify each transactions that is passed through them. Arcadier does not created these Transaction IDs as they are created by the payment gateway once you run a payment through them. You can use this ID to track the payment status for to search for past transactions within the payment gateway platform. In a standard Arcadier checkout, there will be x+1 transactions, with x equals to the number of Merchants involved in the checkout and 1 is a transaction to the Admin for commission fee.

For authorization, the Consumer, you are only able to read invoice details that they checked out. For Merchant, you are able to read order details and update order status related to them. And for Admin, you are able to read all invoices, orders and transactions in your marketplace.



What do you do with Orders ?

POST:

Property Table

Orders Properties

Property Names Property Type Description
InvoiceId

Optional

string

"InvoiceId": "LANSPAC-1531884269659"

Unique number of the invoice.

OrderId

Optional

integer

"OrderId":  16436

The order line unique id. This is an id given to each Item within an order.

OrderLineId

Optional

string

"OrderLineId": "21099"

The order line unique id. This is an id given to each Item within an order.

MerchantId

Optional

integer

"MerchantId": 6617

The merchant/seller id

DeliveryName

Optional

string

"DeliveryName": "John Wick"

The name of the delivery recipient.

BuyerId

Optional

integer

"BuyerId": 10909

The consumer id

BuyerFirstName

Optional

string

"BuyerFirstName":  "John"

The first name of the consumer

BuyerLastName

Optional

string

"BuyerLastName": "Wick"

The last name of the consumer

BuyerEmail

Optional

string

"BuyerEmail": "johnwick@gmail.com"

The email address of the consumer

BuyerPhoneNumber

Optional

string

"BuyerPhoneNumber":  "813-404-5731"

The contact number of the consumer

TimeStamp

Optional

string

"TimeStamp": "18/07/2018 03:23"

The timestamp of when order is made.

Gateway

Optional

string

"Gateway": "Stripe"

The name of the payment gateway that is used for the order.

AddressLine1

Optional

string

"AddressLine1": "1904 Virginia St"

The address name of the order delivery recipient line 1.

AddressLine2

Optional

string

"AddressLine2": "Apt 4"

The address name of the order delivery recipient line 2.

City

Optional

string

"City": "Berkeley"

The city of the order delivery recipient.

Country

Optional

string

"Country": "United State"

The country of the order delivery recipient.

State

Optional

string

"State": "CA"

The state of the order delivery recipient.

PostalCode

Optional

string

"PostalCode": 884426

The postal code /  zip code of the order delivery recipient.

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the order item based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

ItemName

Optional

string

"ItemName": "Hot Desk @ SpaceMob"

The order item name

ItemPrice

Optional

string

"ItemPrice": "30.00"

The order item price

ItemPriceUnit

Optional

string

"ItemPriceUnit": "day"

The order item price unit. Example for service item will be "1 service" while for rental item will be "per 30 minutes".

Quantity

Optional

string

"Quantity": "2.00"

The quantity of the order item

StartDate

Optional

string

"StartDate": "19/0702018"

The start date of the order item

StartTime

Optional

string

"StartTime": "00:00"

The start time of the order item

EndDate

Optional

string

"EndDate": "20/07/2018"

The end date of the order item

EndTime

Optional

string

"EndTime": "00:00"

The end time of the order item

GrandTotal

Optional

string

"GrandTotal":  "USD 60.00"

The order grand total is the sum of order subtotal and delivery cost minus the sum of bulk delivery discount and admin commission fee.

Total

Optional

string

"Total": "USD 60.00"

The subtotal of the order

Freight

Optional

string

"Freight": "USD 0.00"

The total delivery cost without bulk delivery discount.

AdminFee

Optional

string

"AdminFee": "0.00"

The admin fee charges for the order

BulkDeliveryDiscount

Optional

string

"BulkDeliveryDiscount": "USD 0.00"

The cost of the bulk delivery discount.

Status

Optional

string

"Status":  "Completed"

The status of the item in the order which is similar to Order Status

OrderStatus

Optional

string

"OrderStatus": "Fully Paid"

The status of order:

  • Created

  • Payment Requested

  • Fully Paid

  • Partially Paid

  • Unpaid

  • Settled

  • Completed

FulfilmentStatus

Optional

string

"FulfilmentStatus": "Delivered"

The status of order fulfilment for pickup:

  • Acknowledged

  • Ready For Consumer Collection

  • Collected



The status of order fulfilment for delivery:

  • Acknowledged

  • Delivered

PaymentStatus

Optional

string

"PaymentStatus": "Paid"


The status of order payment:


  • Acknowledged

  • Processing

  • Waiting For Payment

  • Pending

  • Paid

  • Failed

  • Refunded

DeliveryType

Optional

string

"DeliveryType":  ""

The type of delivery, for self pickup it will be shown as pickup while delivery will be shown as delivery. If value is null, then there is no delivery

Notes

Optional

string

"Notes": "Can i have a trash can under my desk."

The message from the consumer.

CartItems

Optional

Array[ItemObject]

CartItems: [
{
      "Id": 21099,
  "ItemId": 5230,
  "ItemName": "Hot Desk @ SpaceMob",
  "InvoiceId": "LANSPAC-1531884269659",
  "Qty": "2",
  "DeliveryType": "",
  "CartItemStatus": "Completed",
  "Price": "USD 30.00",
  "PriceUnit": "day",
     "DateFrom": "7/19/2018",
     "DateTo": "7/20/2018",
     "TimeFrom": "00:00",
     "TimeTo": "00:00",
     "NumberOfHours":  "1",
      "Notes": "Can i have a trash can under my desk."
  "MerchantEmail": "hello@space.com",
  "MerchantContact": "602-503-6112"
}
]

The CartItems contains the list of items that are in the Order

OrderLines

Optional

Array[OrderObject]

"OrderLines": [
{
  "OrderLineId": "21099",
  "ItemId": 5230,
  "ItemName": "Hot Desk @ SpaceMob",
  "CurrencyCode": "USD",
  "ItemPrice": 30,
  "Quantity": 2,
  "Status": "Completed",
  "DeliveryType": "",
  "ShippingMethodCost": 0,
     "Notes": "Can i have a trash can under my desk.",
     "StartDate": "19/07/2018",
     "StartTime": "00:00",
     "EndDate": "20/07/2018",
     "EndTime": "00:00"
}
 ]

The order line contain list of order item

Cart Items Properties

Property Names Property Type Description
CartItemId

Optional

integer

"CartItemId": 10881

The id of the cart item.

ItemId

Optional

integer

"ItemId": 5514

The id of the item.

DeliveryId

Optional

integer

"DeliveryId": 6601

The id of the delivery

DeliveryType

Optional

string

"DeliveryType": "delivery"

The type of delivery, for self pickup it will be shown as pickup while delivery will be shown as delivery

ItemName

Optional

string

"ItemName": "Nike Roshe 1"

The item name in the order

InvoiceId

Optional

string

"InvoiceId": "SNEAKERLAB-1520494879"

Unique number of the invoice.

Qty

Optional

string

"Qty": "1"

The quantity of the item ordered. This is the number of time slot selected. For example, every booking is 1 night, can you want to book 2 consecutive nights straight. this Quantity will show 2.  

Fee

Optional

string

"Fee": "2"

The admin fee charge

Address

Optional

string

"Address": "1936 Chestnut Street Tampa FL 33610"

The delivery address.

CartItemStatus

Optional

string

"CartItemStatus": "Preparing" 
The status of cart item ordered:

  • Acknowledged
  • Preparing
  • Ready for Courier Collection
  • Shippied
  • Ready for Consumer Collection
  • Collected
  • Delivered
Price

Optional

number

"Price": 100

The price of the ordered item.

PriceUnit

Optional

string

"PriceUnit": "per Item"

The price unit of the item i.e 30 per hour.

Notes

Optional

string

"Notes": "Please double wrap the items that i have ordered. Thanks"

The information from the consumer.

MerchantEmail

Optional

string

"MerchantEmail": "hello@sneakerlab.com"

The merchant email

MerchantContact

Optional

string

"MerchantContact": "602-503-6112"

The merchant contact number

Location

Optional

string

"Location": "2212 Hillside Drive Lafayette Louisiana 70506"

The merchant address

TotalPrice

Optional

string

"TotalPrice": "USD 100.00"

The sum of Price x Quantity

Order Line Properties

Property Names Property Type Description
OrderLineId

Optional

string

"OrderLineId": "210896"

Unique order line id. This is an id given to each Item within an order.

ParentItemId

Optional

integer

"ParentItemId": 5501

The ID of the item

ItemId

Optional

integer

"ItemId": 5511

The Id of the item variant.

ItemName

Optional

string

"ItemName": "Nike Epic React Flynit"

The name of the item.

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the item price based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

ItemPrice

Optional

number

"ItemPrice": 100

The price of the Item

ItemPriceUnit

Optional

string

"ItemPriceUnit": "per Item"

The price unit of the item i.e 30 per hour. This is for Spacetime only.

Quantity

Optional

integer

"Quantity": 1

The quantity of the item order

Status

Optional

string

"Status": "Fully Paid"

Status of the order Item. The status is related to OrderStatus

OrderStatus

Optional

string

"OrderStatus": "Fully Paid"

The status of order:

  • Created

  • Payment Requested

  • Fully Paid

  • Partially Paid

  • Unpaid

  • Settled

  • Completed

FulfilmentStatus

Optional

string

"FulfilmentStatus": "Delivered"

The status of order fulfilment for pickup:

  • Acknowledged

  • Ready For Consumer Collection

  • Collected


The status of order fulfilment for delivery:

  • Acknowledged

  • Delivered

PaymentStatus

Optional

string

"PaymentStatus": "Paid"

The status of order payment:


  • Acknowledged

  • Processing

  • Waiting For Payment

  • Pending

  • Paid

  • Failed

  • Refunded

DeliveryId

Optional

integer

"DeliveryId": 6601

The id of the delivery method

DeliveryType

Optional

string

"DeliveryType":  "delivery"

The type of delivery, for self pickup it will be shown as pickup while delivery will be shown as delivery

ShippingMethodCost

Optional

number

"ShippingMethodCost": 4

The cost of the shipping method

ShippingMethod

Optional

string

"ShippingMethod": "Q-Express"

The type of Shipping Method

Notes

Optional

string

"Notes": "Please double wrap the items that i have ordered. Thanks"

The information from the buyer.

PickUpAddress

Optional

string

"PickupAddress": "1936  Chestnut Street Tampa FL 33610"

The Pickup address for the order

Was this article helpful?
0 out of 0 found this helpful