1. Home
  2. Help
  3. Channel - Website
  4. Data Object: Order

Data Object: Order

Get Orders List


{{ data.order.list({}) }}

  1. Success Response
HTTP/1.1 200 OK
{
    {
         id: 2,
         number: "CM-1526",
         amount: 1500,
         deliveryAmount: 500,
         totalAmount: 2000,
         currencyId: 1,
         currencyName: "AMD",
         paymentMethodId: 2,
         referralId: "5044555541",
         status: 3,
         statusName: "Paid",
         shippingStatus: 2,
         shippingStatusName: "In progress", 
         created: "2016-03-21 10:30:00",
         items: [
               {
                    id: 12,
                    orderId: 2,	
                    productId: 10,
                    product: {
                        See "Get Product"
                    },
                    quantity: 2,
                    price: 400,
                    deliveryAmount: 0,
                    currencyId: 1,
                    currencyName: "AMD",
                    created: "2016-03-21 10:30:00",
                    updated: "2016-03-22 08:30:00",
               },
               ...
         ]
    }
    ...
}

or

[]

  1. Response Parameters
Parameter Type Description
id int Order identifier
number string Order unique number
amount float Order amount
deliveryAmount float Order delivery amount
totalAmount float Order total amount
currencyId int Order currency identifier
currencyName string Order currency name
paymentMethodId int Order payment method identifier
referralId int Order payment method referral identifier
status int Order status identifier
statusName string Order status title
shippingStatus string Order shipping status identifier
shippingStatusName string Order shipping status title
created string Order creation date
items array Order items
item.id int Order item identifier
item.orderId int Order identifier
item.productId int Order item product identifier
item.product obj Cart item product entity
item.quantity int Order item quantity
item.price float Order item price
item.deliveryAmount float Order item deliver amount
item.currencyId int Order item currency identifier
item.currencyName string Order item currency name
item.created string Order item creation date
item.updated string Order item modified date


Get Order


{{ data.order.get(:id) }}

  1. Request Parameters
Parameter Type Description
id required int Order Identifier

  1. Success Response
HTTP/1.1 200 OK
{
    id: 2,
    number: "CM-1526",
    amount: 1500,
    deliveryAmount: 500,
    totalAmount: 2000,
    currencyId: 1,
    currencyName: "AMD",
    paymentMethodId: 2,
    referralId: "5044555541",
    status: 3,
    statusName: "Paid",
    shippingStatus: 2,
    shippingStatusName: "In progress", 
    created: "2016-03-21 10:30:00",
    items: [
          {
               id: 12,
               orderId: 2,	
               productId: 10,
               product: {
                    See "Get Product"
               },
               quantity: 2,
               price: 400,
               deliveryAmount: 0,
               currencyId: 1,
               currencyName: "AMD",
               created: "2016-03-21 10:30:00",
               updated: "2016-03-22 08:30:00",
         },
         ...
         ]
    }
}

or

false

  1. Response Parameters
Parameter Type Description
id int Order identifier
number string Order unique number
amount float Order amount
deliveryAmount float Order delivery amount
totalAmount float Order total amount
currencyId int Order currency identifier
currencyName string Order currency name
paymentMethodId int Order payment method identifier
referralId int Order payment method referral identifier
status int Order status identifier
statusName string Order status title
shippingStatus string Order shipping status identifier
shippingStatusName string Order shipping status title
created string Order creation date
items array Order items
item.id int Order item identifier
item.orderId int Order identifier
item.productId int Order item product identifier
item.product obj Cart item product entity
item.quantity int Order item quantity
item.price float Order item price
item.deliveryAmount float Order item deliver amount
item.currencyId int Order item currency identifier
item.currencyName string Order item currency name
item.created string Order item creation date
item.updated string Order item modified date


Get Order for Checkout


{{ data.order.checkout() }}

  1. Success Response
HTTP/1.1 200 OK
{
    id: 2,
    number: "CM-1526",
    amount: 1500,
    deliveryAmount: 500,
    totalAmount: 2000,
    currencyId: 1,
    currencyName: "AMD",
    paymentMethodId: 2,
    referralId: "5044555541",
    status: 3,
    statusName: "Paid",
    shippingStatus: 2,
    shippingStatusName: "In progress", 
    created: "2016-03-21 10:30:00",
    items: [
          {
               id: 12,
               orderId: 2,	
               productId: 10,
               product: {
                    See "Get Product"
               },
               quantity: 2,
               price: 400,
               deliveryAmount: 0,
               currencyId: 1,
               currencyName: "AMD",
               created: "2016-03-21 10:30:00",
               updated: "2016-03-22 08:30:00",
         },
         ...
         ]
    }
}

or

false

  1. Response Parameters
Parameter Type Description
id int Order identifier
number string Order unique number
amount float Order amount
deliveryAmount float Order delivery amount
totalAmount float Order total amount
currencyId int Order currency identifier
currencyName string Order currency name
paymentMethodId int Order payment method identifier
referralId int Order payment method referral identifier
status int Order status identifier
statusName string Order status title
shippingStatus string Order shipping status identifier
shippingStatusName string Order shipping status title
created string Order creation date
items array Order items
item.id int Order item identifier
item.orderId int Order identifier
item.productId int Order item product identifier
item.product obj Cart item product entity
item.quantity int Order item quantity
item.price float Order item price
item.deliveryAmount float Order item deliver amount
item.currencyId int Order item currency identifier
item.currencyName string Order item currency name
item.created string Order item creation date
item.updated string Order item modified date
english flag English
© 2024 storech.com    All rights reserved