/
v3.0.11Get access

getShopOrders

Fetches the loyalty store order history filtered by order state and creation date range

Request parameters:

Name
DescriptionTypeValuesDefault
createStart
The start date/time in milliseconds to filter from.number--
createEnd
The end date/time in milliseconds to filter to.number--
state
Filter orders by their current state/status. If state is not sent, user will receive all ordersstring"new", "shipped", "delivered", "canceled"-

Parameters marked with must be included in the request

This method is usually used with these methods:
createShopOrder

Call example:

getShopOrders({
  state: 'completed',
  createStart: 1716000000,
  createEnd: 1716600000
})

Response examples:

{
  code: 0,
  rid: 1750382449,
  data: {
    result: 0,
    data: [{
      Id: 14936069,
      ClientId: 1101427307,
      PartnerId: 18749451,
      Created: 1710334135,
      Delivered: 1710334135,
      Address: '',
      Name: 'dddd Davit Margaryan QA',
      State: 3,
      Price: 300,
      DocId: 152766772433,
      ShopOrderItems: []
    }, {
      Id: 14936064,
      ClientId: 1101427307,
      PartnerId: 18749451,
      Created: 1710334125,
      Delivered: 1710334126,
      Address: '',
      Name: 'dddd Davit Margaryan QA',
      State: 3,
      Price: 300,
      DocId: 152766761666,
      ShopOrderItems: []
    }]
  }
}

Response parameters:

NameDescriptionTypeValues
array-
└─
object
└─ Id
The Id of the ordernumber-
└─ ClientId
The Id of the usernumber-
└─ PartnerId
The Id of the partnernumber-
└─ Created
The creation date of the ordernumber-
└─ Delivered
The delivery date of the ordernumber-
└─ Address
The address of the userstring-
└─ Name
The name of the orderstring-
└─ State
The state of the order "" = all, 1 = new, 2 = shipped, 3 = delivered, 4 = canceled .string1, 2, 3, 4,
└─ Price
The price of the ordernumber-
└─ DocId
The docId of the ordernumber-