How to list orders

Configure the API to list your orders in the system.
BF
Written by Beeping Fulfilment SL
Updated 10 months ago

This method allows you to list all orders in the system per user team. To access this step, you must first perform the basic authentication.

Method: GET

Uri: api/get_orders

Endpoint: http://app.gobeeping.com/api/get_orders

Curl Example

curl --location --request GET 'app.gobeeping.com/api/get_orders' \
--header 'Authorization: Basic XXXXXXXXXX'

curl --location --request GET 'app.gobeeping.com/api/get_orders?from_date=01-10-2022&in=4320676020324, 4254361518180&shop_id=3' \
--header 'Authorization: Basic XXXXXXXXXX'

Supported filters are:

FILTER  DESCRIPTION
in Only supports external_id separated by commas
from_date Date from which to display orders, in dd-mm-yyyy format
shop_id Shop ID
per_page Limit of results per page

An example response could be:

{
  "external_id": "4722044222200",
  "ref": "#1111",
  "shop_id": 1,
  "status": "4",
  "payment_method": "Cash on Delivery (COD)",
  "amount": 29.99,
  "total_discount": 0,
  "total_shipping": 0,
  "total_tax": 0,
  "financial_status": "pending",
  "date_tracking_update": null,
  "tracking_stage": "600",
  "courier_id": "1",
  "tracking_number": "6330015519199627",
  "payment_method_id": 3,
  "date": "2022-09-23 11:35:06",
  "lines": [
    {
      "name": "Producto 1",
      "code": "9123841811",
      "cost": null,
      "image_hash": "",
      "amount": 29.99,
      "qty": 1,
      "sku": "9123841811",
      "barcode": null
    }
  ]
}

As you can see in the example, we have status 4, tracking_stage 600 and courier 1. In these fields you can get answers with different numbers that correspond to different types of information.

Here is a list so that you can easily interpret each response.

Order statuses (status)

  • 1 - Pending
  • 2 - Pending stock
  • 3 - In preparation
  • 4 - Shipped
  • 5 - Returned
  • 6 - To be confirmed
  • 0 - Cancelled

Logistics status (order_shipment_status_id)

  • 1 - No logistic status
  • 2 - In Transit
  • 3 - Out for Delivery
  • 4 - Pickup Point
  • 5 - Delivered
  • 6 - Returned to Sender
  • 7 - Cancelled
  • 8 - Damaged

Couriers (courier_id)

  • 1 - Correos Express
  • 2 - Seur
  • 3 - Correos

If you need to know how to mark orders for shipping, here we show you how to do it.

Did this answer your question?