GET Orders

This call allows you to fetch all the orders from Browntape, given a company ID. You can use various useful filters while making this fetch.

Note: You will notice that some unwanted/to-be-deprecated fields are included in this API call. For performance reasons, they are not removed from the API. Orders are the most crucial entity and we wish to keep the performance up.

1 End Point
2 Parameters to be passed
3 Response
4 Order statuses in Browntape
- 4.1 Financial Statuses
- 4.2 Fulfillment Statuses
- 4.3 Order Type Values
- 4.4 Order Statuses

End Point

https://app.browntape.com/0.1/orders/index.json

Parameters to be passed

?username=XXXXXXXXXX
&auth_string=YYYYYYYYY
&created_from='2014-01-01 00:00:00' (optional)
&created_to='2014-04-01 00:00:00'(optional)
&modified_from='2014-01-01 00:00:00' (optional)
&modified_to='2014-04-01 00:00:00'(optional)
&fetched_from='2014-01-01 00:00:00' (optional, NOTE: This date represents the time at which the order was fetched into Browntape.)
&fetched_to='2014-04-01 00:00:00' (optional, NOTE: This date represents the time at which the order was fetched into Browntape.)
&channel_id[] = 3 (optional, multiple values accepted)
&order_id[] = 12345 (optional, multiple values accepted)
&fulfillment_status_id[]= courier assigned/delivered/cancelled/delivered/lost in transit/manifested/on hold/order accepted/outfordelivery/packed/packing/pending acceptance/pickedup
/pendingpickup/ready to ship/processing/reschedule pickup/return not expected/return initiated/rto return pending/rto return received/return received
/return pending/return requested/upcoming/waitingforpickup(optional , multiple values may be passed) 
&financial_status_id= cod/declined/cancelled/paid/processing/refunded/reversed/unpaid(optional , multiple values may be passed)
&order_reference=XYZ (optional)
&order_reference2=PQR (optional)
&warehouse_id[]=123 (optional, multiple values accepted)
&sku_code[] ='XYZ'(optional. Multiple values may be sent. Upto 100 values are accepted)
&stock_adjusted  = 0/1/2 (optional. 0 - Stock not adjusted, 1 - Stock Adjusted, 2 - Stock adjustment ignored)
&skip_unmapped_sku_orders = 0/1 (optional. 0 - dont skip orders having unmapped sku, 1 - skip orders having unmapped sku)
&convert_currency=1 (optional,DEFAULT = 0,  Note: When this setting is set to 1, all currency values in this api will be converted to the currency specified in browtape settings) 
&search_query=abc (optional, Note: If this param is set, all other params are ignored)
&imei_number=NULL (optional. Note: NULL is _only_ allowed for this field. Internally, it will check for NULL value and empty string. Value passed as to be NULL in caps)
&erp_order_ref=123 (optional)
&erp_invoice_ref=123 (optional)
&erp_shipment_ref=123 (optional)
&order_status_id[]= cancelled/closed/disputed/open/partially cancelled/partially fulfilled/partially return initiated/partially return received (optional , multiple values may be passed)
&page=1
&limit = 200 (optional. Default - 200 , Max - 200)

Response

{
  "success": "true",
  "result_count": 6,
  "results_per_page": 100,
  "page": "1",
  "data": [
    {
      "Order": {
        "id": "13165230578",
        "is_cod": "0",
        "order_type": null,
        "created": "2023-04-10 13:52:16",
        "modified": "2023-04-14 18:21:12",
        "gross_value": "130.00",
        "fees_value": null,
        "channel_id": "32002",
        "parent_id": null,
        "shipping_value": "0.00",
        "cod_fees_value": "0",
        "customer_id": "312780741",
        "shipping_address_id": "80372624",
        "order_status_id": "2440737",
        "financial_status_id": "2",
        "fulfillment_status_id": "5",
        "marketplace_status": null,
        "shipping_batch_id": null,
        "manifest_id": null,
        "currency_id": "63",
        "executed_shipping_method": "ecom express",
        "tracking_number": "65637",
        "imei_number": null,
        "is_scanned": "0",
        "stock_adjusted": "1",
        "order_reference": "5160727707884::ship#14dd9859f6",
        "order_reference2": "1498",
        "selected_shipping_method": null,
        "uuid": "15547354906433cbdda708e7.946",
        "unread": "1",
        "dispatch_date": "2023-04-10 08:42:05",
        "bt_fulfillment_status_id": "5",
        "bt_order_status_id": "2440737",
        "bt_financial_status_id": null,
        "remittance_date": null,
        "remittance_note": null,
        "remitted_value": null,
        "invoice_prefix": "2022-23",
        "invoice_separator": "/",
        "invoice_number": "939",
        "courier_company_id": "32",
        "invoice_path": null,
        "order_manifest_path": null,
        "invoice_number_on_channel": null,
        "order_declaration_path": null,
        "ship_label_path": null,
        "courier_status_id": "1",
        "order_statement_path": null,
        "courier_status_raw": null,
        "courier_tracking_attempts": "0",
        "courier_tracked_on": "2023-04-11 04:01:56",
        "warehouse_id": "57620",
        "tax_rule_id": null,
        "weight_gm": "10",
        "length_mm": "20",
        "breadth_mm": "20",
        "height_mm": "20",
        "problem_reason": null,
        "replacement_order_id": null,
        "replaced_order_id": null,
        "replacement_pending": null,
        "created_on": "2023-04-10 14:12:05",
        "invoice_prefix_2": "tech",
        "invoice_separator_2": "/",
        "vat_forms": null,
        "first_printed_on": null,
        "invoice_generated_on": "2023-04-10 08:46:59",
        "pickup_date": null,
        "pickup_time_band": null,
        "is_replacement": "0",
        "erp_invoice_ref": null,
        "erp_order_ref": null,
        "erp_shipment_ref": null,
        "company_id": "8240",
        "biz_type": null,
        "credit_note_number_on_channel": null,
        "billing_address_id": "551619492",
        "marketplace_fulfilled": false,
        "is_cancellable_on_channel": false,
        "gstin": "12",
        "vatlinks": ""
      },
      "Channel": {
        "id": "32002",
        "email": null,
        "email_from_name": null,
        "email_bcc": null,
        "invoice_template": null,
        "title": "Omni QA STORE  BT",
        "stock_sync": "1",
        "ChannelType": {
          "id": "201",
          "favicon_path": "/img/icons/icon_favshopify.png",
          "standard_tag": "shopify_omni",
          "title": "Shopify Omni",
          "is_marketplace": "0"
        }
      },
      "Customer": {
        "id": "312780741",
        "salutation": null,
        "first_name": "Hari",
        "last_name": "Haran",
        "email": "neel@browntape.com",
        "phone": null,
        "nickname": null,
        "created": "2022-10-07 07:26:16",
        "modified": "0000-00-00 00:00:00",
        "customer_reference": "6327656186092",
        "channel_id": "32002",
        "full_name": "Hari Haran",
        "company_name": null
      },
      "ShippingAddress": {
        "id": "80372624",
        "address_line1": "XYZ",
        "address_line2": "XYZ",
        "address_line3": null,
        "city": "Mumbai",
        "state": "Maharashtra",
        "country": "India",
        "country_code": "IN",
        "zip": "400001",
        "address_name": "Hari Haran",
        "phone": null,
        "extra_info": null
      },
      "Currency": {
        "id": "63",
        "abbreviation": "INR",
        "name": "Indian Rupee",
        "symbol": "₹",
        "created": "0000-00-00 00:00:00",
        "modified": "2023-04-14 01:50:04",
        "rate": "81.6812",
        "priority": "0",
        "flag": "1"
      },
      "OrderStatus": {
        "id": "2440737",
        "title": "open"
      },
      "FinancialStatus": {
        "id": "2",
        "title": "paid"
      },
      "ShippingBatchs": {
        "id": null,
        "created": null,
        "user_id": null,
        "batch_reference": null,
        "company_id": null,
        "title": null,
        "pickup_date": null,
        "bulk_label_path": null,
        "pickup_time_band": null,
        "order_count": null,
        "channel_id": null,
        "channel_type_id": null,
        "product_id": null,
        "order_type": null,
        "order_created_date": null,
        "warehouse_id": null,
        "channel_ref": null,
        "erp_ref": null
      },
      "FulfillmentStatus": {
        "id": "5",
        "title": "return initiated"
      },
      "Manifest": {
        "id": null,
        "manifest_reference": null,
        "created": null,
        "courier_company": null,
        "picked_up_at": null,
        "courier_boy_name": null,
        "courier_boy_phone": null,
        "company_id": null,
        "schedule_pickup_token": null,
        "manifest_url": null,
        "manifest_type": null,
        "manifest_status_id": null,
        "modified": null,
        "channel_type_id": null,
        "warehouse_id": null,
        "channel_id": null,
        "pickup_datetime": null,
        "extra_info": null
      },
      "CourierCompany": {
        "id": "32",
        "title": "Ecom Express",
        "accepted_names": "[\"ECOM EXPRESS\",\"ECOM_EXPRESS\",\"ECOM-EXPRESS\",\"Ecom Express\",\"Ecom_Express\",\"Ecom-Express\",\"ecom_express\",\"ecom-express\",\"ecom_express\\/ecom_express\",\"EcomExpress\"]",
        "standard_tag": "ecomexpress",
        "manifest_report_type_id": "7"
      },
      "CourierStatus": {
        "id": "1",
        "title": "initiated"
      },
      "Warehouse": {
        "id": "57620",
        "title": "default",
        "created": "2022-07-29 10:21:42",
        "modified": "2023-02-20 07:34:14",
        "company_id": "8240",
        "is_default": "1",
        "warehousing_account_id": null,
        "last_polled": "0000-00-00 00:00:00",
        "external_warehouse_code": null,
        "restricted_to_channel_id": null,
        "address_line1": "3rd floor ,browntape",
        "address_line2": "complex",
        "landmark": "FOOTBALL GROUND",
        "city": "Pednem",
        "state": "Goa",
        "pincode": "403001",
        "country": "India",
        "phone": "9863521458",
        "email": "techpeople@gmail.com",
        "warehouse_short_code": "def",
        "unique_code": null,
        "warehouse_type": "warehouse",
        "sub_type": "coco",
        "warehouse_code": null,
        "settings_json": "{\"shipway_warehouse_id\":\"20151\",\"ithink_logistics_id\":\"26127\"}",
        "udf_num1": null,
        "udf_num2": null,
        "udf_num3": null,
        "udf_num4": null,
        "udf_num5": null,
        "udf_string1": null,
        "udf_string2": null,
        "udf_string3": null,
        "udf_string4": null,
        "udf_string5": null,
        "udf_date1": null,
        "udf_date2": null,
        "udf_date3": null,
        "udf_date4": null,
        "udf_date5": null
      },
      "TaxRule": {
        "id": null,
        "title": null,
        "company_id": null,
        "condition_field": null,
        "condition_value": null,
        "tax_percentage": null,
        "created": null,
        "is_default": null
      },
      "item_titles_orders": {
        "id": "12909395301",
        "order_id": "13165230578",
        "pre_order_line_id": "15545163",
        "quantity": "1",
        "shipped_qty": null,
        "picked_qty": null,
        "cancelled_qty": null,
        "ordered_qty": "1",
        "tracking_ref": null,
        "item_title_id": "737061328",
        "gross_value": "130",
        "item_url": null,
        "number": "12910567162092",
        "priority_flag": null,
        "item_options": null,
        "tax_rule_id": "314116",
        "tax_type": "igst",
        "tax_amount": "13.9286",
        "tax_rate_percent": "12",
        "shipping_batch_id": null,
        "manifest_id": null,
        "packer_id": null,
        "executed_shipping_method": null,
        "tracking_number": null,
        "courier_routing_code": null,
        "selected_shipping_method": null,
        "dispatch_date": "0000-00-00 00:00:00",
        "bt_cancel_date": null,
        "channel_cancel_date": null,
        "bt_return_date": null,
        "channel_return_date": "2023-04-14 12:51:12",
        "courier_status_id": null,
        "courier_company_id": null,
        "courier_tracked_on": "0000-00-00 00:00:00",
        "courier_status_raw": null,
        "courier_tracking_attempts": "0",
        "ship_label_path": null,
        "fulfillment_status_id": null,
        "shipping_value": "0",
        "sub_order_reference": "12910567162092",
        "warehouse_id": "57620",
        "stock_flag": "2",
        "dispatch_by_date": "2023-04-13 13:52:16",
        "discount_amount": "0",
        "imei_no": null,
        "scanned_quantity": "0",
        "item_attributes": "{\"tax\":{\"shipping\":{\"item_amount\":0,\"unit_amount\":0,\"item_tax_amount\":0,\"unit_tax_amount\":0},\"cod\":{\"item_amount\":0,\"unit_amount\":0,\"item_tax_amount\":0,\"unit_tax_amount\":0},\"discount\":{\"item_amount\":0,\"unit_amount\":0,\"item_tax_amount\":0,\"unit_tax_amount\":0}}}"
      },
      "ItemTitle": [
        {
          "id": "737061328",
          "title": "Black earphones",
          "sku_id": "15792400",
          "sku_code_from_channel": "G1000",
          "company_id": "0",
          "number": "12910567162092",
          "channel_product_ref": "12910567162092",
          "ItemTitlesOrder": {
            "giftwrap_charges": null,
            "giftwrap_tax_amount": null,
            "metadata": null,
            "dispatch_after_date": null,
            "id": "12909395301",
            "order_id": "13165230578",
            "pre_order_line_id": "15545163",
            "quantity": "1",
            "shipped_qty": null,
            "picked_qty": null,
            "cancelled_qty": null,
            "ordered_qty": "1",
            "tracking_ref": null,
            "item_title_id": "737061328",
            "gross_value": "130",
            "item_url": null,
            "number": "12910567162092",
            "priority_flag": null,
            "item_options": null,
            "tax_rule_id": "314116",
            "tax_type": "igst",
            "tax_amount": "13.9286",
            "tax_rate_percent": "12",
            "shipping_batch_id": null,
            "manifest_id": null,
            "packer_id": null,
            "executed_shipping_method": null,
            "tracking_number": null,
            "courier_routing_code": null,
            "selected_shipping_method": null,
            "dispatch_date": "0000-00-00 00:00:00",
            "bt_cancel_date": null,
            "channel_cancel_date": null,
            "bt_return_date": null,
            "channel_return_date": "2023-04-14 12:51:12",
            "courier_status_id": null,
            "courier_company_id": null,
            "courier_tracked_on": "0000-00-00 00:00:00",
            "courier_status_raw": null,
            "courier_tracking_attempts": "0",
            "ship_label_path": null,
            "fulfillment_status_id": null,
            "shipping_value": "0",
            "sub_order_reference": "12910567162092",
            "warehouse_id": "57620",
            "stock_flag": "2",
            "dispatch_by_date": "2023-04-13 13:52:16",
            "discount_amount": "0",
            "imei_no": null,
            "scanned_quantity": "0",
            "item_attributes": "{\"tax\":{\"shipping\":{\"item_amount\":0,\"unit_amount\":0,\"item_tax_amount\":0,\"unit_tax_amount\":0},\"cod\":{\"item_amount\":0,\"unit_amount\":0,\"item_tax_amount\":0,\"unit_tax_amount\":0},\"discount\":{\"item_amount\":0,\"unit_amount\":0,\"item_tax_amount\":0,\"unit_tax_amount\":0}}}",
            "TaxRule": {
              "id": "314116",
              "tax_percentage": "0"
            },
            "hsn": "8517",
            "tax_info": [
              {
                "type": "IGST",
                "rate": "12"
              }
            ]
          },
          "Sku": {
            "id": "15792400",
            "custom_code": "tech9",
            "style_code": "",
            "readable_name": "samsung",
            "length_mm": "20",
            "product_id": "109450",
            "is_bundle": "0",
            "breadth_mm": "20",
            "height_mm": "20",
            "weight_gm": "10",
            "image_path": null,
            "default_cost_price": "11000",
            "master_mrp": "15000",
            "color": "white",
            "size": "10",
            "is_disabled": "0",
            "hsn_code_id": "35379"
          },
          "brand": ""
        }
      ],
      "Sku": {
        "id": "15792400",
        "readable_name": "samsung",
        "custom_code": "tech9",
        "image_path": null,
        "image_thumb_path": null,
        "input_image_path": "",
        "company_id": "8240",
        "_in_stock_quantity": "766",
        "sla_days": "2",
        "awaiting_dispatch_quantity": "633",
        "length_mm": "20",
        "breadth_mm": "20",
        "height_mm": "20",
        "weight_gm": "10",
        "bundle_id": null,
        "is_disabled": "0",
        "is_bundle": "0",
        "default_cost_price": "11000",
        "least_selling_price": "14000",
        "created": "2022-09-28 08:02:46",
        "modified": "2023-04-13 11:40:10",
        "currency_id": "63",
        "is_low_stock": "0",
        "low_stock_level": "2",
        "product_id": "109450",
        "stock_sync": "1",
        "product_category_id": null,
        "custom_product_category_id": null,
        "tax_rule_id": null,
        "style_code": "",
        "color": "white",
        "size": "10",
        "master_mrp": "15000",
        "master_selling_price": null,
        "has_imei": "0",
        "has_batches": null,
        "hsn_code_id": "35379",
        "brand_id": "41858"
      },
      "Transaction": [
        {
          "id": "329697986",
          "source_transaction_ref": "6041689456876",
          "source": "manual",
          "order_id": "13165230578",
          "pre_order_id": "0",
          "note": "sale",
          "gross_value": "130.00",
          "fees_value": "0",
          "created": "2023-04-10 08:42:05",
          "currency_id": null
        }
      ],
      "Message": [
        
      ],
      "OrderDiscount": [
        
      ],
      "BillingAddress": {
        "id": "551619492",
        "address_line1": "XYZ",
        "address_line2": "XYZ",
        "address_line3": null,
        "city": "Mumbai",
        "state": "Maharashtra",
        "country": "India",
        "country_code": "IN",
        "zip": "400001",
        "address_name": "Hari Haran",
        "phone": null,
        "extra_info": null
      },
      "ItemTitlesOrdersReturn": [
        {
          "id": "5651155",
          "item_titles_order_id": "12909395301",
          "return_number": "efdcc0585f0f71174c8f",
          "good_return_quantity": "0",
          "bad_return_quantity": "0",
          "tracking_number": null,
          "note": null,
          "executed_shipping_method": null,
          "return_reason": null,
          "channel_return_reason": null,
          "created": "2023-04-14 12:51:12",
          "return_attributes": null,
          "stock_adjusted": "0",
          "modified": "2023-04-14 12:51:12",
          "return_status": "return_initiated",
          "channel_return_qty": "1",
          "channel_return_type": "customer_return",
          "channel_delivery_date": null,
          "channel_return_date": null
        }
      ]
    }
  ]
}

Order statuses in Browntape

Financial Statuses

id	title

id	title
1	unpaid
2	paid
3	refunded
4	reversed
5	cancelled
6	Cod
7	processing
8	declined

Fulfillment Statuses

id	title

id	title
1	processing
2	packing
3	shipped
4	delivered
5	return initiated
6	ready to ship
7	return received
8	on hold
9	return pending
10	return not expected
11	rto return pending
12	rto return received
13	pickedup
14	outfordelivery
15	pendingpickup
16	unshipped
17	waitingforpickup
18	cancelled
19	upcoming
20	reschedule pickup
21	pending acceptance
22	order accepted
23	lost in transit
24	courier assigned
25	packed
26	manifested
27	unknown
28	service complete
30	return closed
121	returned
149	return requested
150	store rejected
151	store onhold
152	return cancelled
180	fully cancelled

Order Type Values

id	title

id	title
1	Snapdeal Plus
2	Snapdeal OneShip
3	Snapdeal DropShip
4	Snapdeal VendorSelf
5	Amazon FBA
6	Ebay Powership
7	Flipkart Advantage
8	Amazon EasyShip
9	Marketplace Fulfilled
12	Paytm Fulfilled
13	Flipkart Smart Fulfilled
17	TataCliq Home Delivery
20	Amazon Flex FBA
21	Seller Shipped Service
22	Self Delivery
23	Store Courier Delivery
null	Merchant Fulfilled

Order Statuses

id	title

id	title
2	closed
3	cancelled
4	disputed
51	partially cancelled
52	partially fulfilled
53	partially return initiated
54	partially return received

Browntape

We’re excited to announce that the latest information is now available on our new site, the Ginesys One Wiki!. Visit the site for up-to-date resources and insights. We look forward to continuing to support you there!