⬆️Request and Response

Request to the API endpoint

Retrieves a list of orders that meet the specified criteria

GET https://api.alephcrm.com/v2/orders

Query Parameters

Name	Type	Description
API_KEY *	string	(default=none)
accountId *	integer	(default=none)
statusType	integer	(default=none)
sort	string	(default=none)
limit	integer	(default=100)
offset	integer	(default=100)
dateCreatedFrom	date (yyyy-mm-dd)	(default=none)
saleDateFrom	date (yyyy-mm-dd)	(default=none)
statusDateFrom	date (yyyy-mm-dd)	(default=none)
idFrom	integer	(default=none)
idTo	integer	(default=none)
externalOrderIdFrom	string	(default=none)
externalOrderIdTo	string	(default=none)
Integrated	boolean	(default=false)
erpStatus	string	(default=none)
marketplaceId	integer
includePendingPayments	boolean	(default=false)
additionalInfo	string	(defaults = see table below)

200: OK Array of orders

{
  "Paging": {
    "Limit": integer,
    "Offset": integer,
    "Total": integer
  },
  "SortBy": {
    "Id": string,
    "Name": string
  },
  "AvailableSorts": [
    {
      "Id": string,
      "Name": string
    },
    {
      "Id": string,
      "Name": string
    }
  ],
  "Total": integer,
  "Results": [
    { OBJECT }
  ]
}

206: Partial Content Array of orders

{
   "Total": integer,
   "Paging": {
       "Limit": integer,
       "Offset": integer,
       "Total": integer,
   },
   "SortBy": {
       "Id": string,
       "Name": string
   },
   "AvailableSorts": [{
       "Id": string,
       "Name": string
   }],
   "Results":[ OrderType ]
}

400: Bad Request {"Status": integer, "Message": string}

401: Unauthorized {"Status": integer, "Message": string}

403: Forbidden {"Status": integer, "Message": string}

404: Not Found {"Status": integer, "Message": string}

412: Precondition Failed {"Status": integer, "Message": string}

416: Range Not Satisfiable {"Status": integer, "Message": string}

429: Too Many Requests {"Status": integer, "Message": string}

500: Internal Server Error string

Parameters details

statusType

Filters the orders by their current status type. Status type is an aggregation of several statuses of an order. Available values are:

Value	Description
0	New
1	Pending
2	Closed
99	Cancelled

This status type aggregation parameter includes the following individual statuses:

Status type	Includes order with statuses (the actual status of an order)
0 = New	0 = No status yet Only for orders from the Alephee B2B portal
1 = Pending	10 = Pending shipping / Ready to ship 17 = Arrived at the pickup point/warehouse location and ready to ship 20 = Shipped (in transit) 30 = Assigned to distributor 31 = Assigned to pickup 87 = The shipment recipient could not be found. Could not be delivered 89 = Could not be delivered due to logistics issues 91 = Awaiting refund 92 = Refunded
2 = Closed	80 = Delivered
99 = Cancelled	11 = Fraudulent order 90 = Cancelled 93 = Cancelled by the buyer after being delivered

dateCreatedFrom

Filters orders which were created in Alephee after the provided date. (Format yyyy-mm-dd HH:mm with HH in 24 hours-format) The creation date is the date on which the order was created or generated in Alephee. It is not the sale date of the order.

saleDateFrom

(Format yyyy-mm-dd HH:mm with HH in 24 hours-format) The sale date is the date on which the order was sold (in whatever marketplace of origin)

statusDateFrom

Filters orders which had a change in status after the provided date. (Format yyyy-mm-dd HH:mm with HH in 24 hours-format) The status date is the date on which the order underwent any novelty or modification in Alephee.

idFrom

Filters orders which ids are equal or greater than the provided one. ID is the internal ID assigned by Alephee to the order.

idTo

Filters orders which ids are equal or lower than the provided one. ID is the internal ID assigned by Alephee to the order.

externalOrderIdFrom

Filters orders which external ids are equal or greater than the provided one. ExternalID is the ID assigned by the marketplace of origin to the order.

externalOrderIdTo

Filters orders which external ids are equal or greater than the provided one. ExternalID is the ID assigned by the marketplace of origin to the order.

Integrated

Filters orders which have been marked as “integrated” or not.

erpStatus

Filters orders which ERP status equals the provided one.

marketplaceId

Filters orders which origin marketplace matches the provided one. Refer to marketplaces ID section and the GET marketplaces endpoint for the coding reference

includePendingPayments

When true, this endpoint will include orders that have payments pending approval (payments not yet approved). By default, the endpoint will only return orders with explicit approved payment. Please refer to the approved payments and pending payments section for more information.

additionalInfo

A collection of additional information to the orders and filters to the result orders list. There is several parameters and filters. Some are assumed by default. You can combine more than one parameter using the “comma” separator. List of available values for the "additionalInfo" parameter:

Parameter	Function
IncludeKitContainerItems (default)	Will include all order items with an item type “Kit” and its related components. Please refer to the ItemType object.
NotIncludeKitContainerItems	Filter all order items with an item type “Kit”.
IncludeStockMovementDetails	Will include the “StockMovements” collection of objects in the order.
NotIncludeStockMovementDetails (default)	Will exclude the “StockMovements” collection of objects in the order.
IncludeExternalJson	Will include the origin-marketplace order JSON in the original format and contents.
NotIncludeExternalJson (default)	Will not include the the origin-marketplace order JSON in the original format and contents.
IncludeWithPendingPayment	This endpoint will include orders that have payments pending approval (payments not yet approved). By default, the endpoint will only return orders with explicit approved payment. Please refer to the approved payments and pending payments section for more information
NotIncludeWithPendingPayment (default)	The opposite of the IncludeWithPendingPayment function.
IncludeIncompletePacksOrders (default)	Include orders from a shopping cart that are incomplete at the moment you call the order endpoint. The pack order can be completed over time.
NotIncludeIncompletePacksOrders	Filters orders from a shopping cart that are incomplete at the moment you call the order endpoint. Will NOT include incomplete pack orders.
OnlyWithAttachedElectronicInvoice	Will return ONLY orders that have a previously attached document. And only those with the “Electronic Invoice” (Brazil only) document type.
OnlyWithAttachedReceipt	Will return ONLY orders that have a previously attached document. And only those with the “Receipt” document type.
OnlyWithAttachedInvoice	Will return ONLY orders that have a previously attached document. And only those with the “Invoice” document type.

Example of the "additionalInfo" parameter:

https://api.alephcrm.com/v2/orders/?........ &additionalInfo=NotIncludeIncompletePacksOrders, OnlyWithAttachedElectronicInvoice This will return orders without incomplete pack orders AND only with attached electronic invoice.

sort

Indicates the field to be sorted by (ascending only). Available fields: ID, dateCreated

limit

Used for paging. Defines the number of records to be returned. For example, limit=10 gets only 10 records.

offset

Used for paging. Moves the inferior limit of the records to the provided one. For example, offset=50 gets the rows skipping the first 50 records.