ForSURE.settingspage.order_labels.orderlist_labels_endpoints

baseURL = '/settings/labels/orderlist'

Base URL for all requests

GET {baseURL}?profile={ID}
async def get_labels_orderlist()

Get the labels for the order list. For each label, the default value will be returned if it has not been changed yet.

Parameters
  • profile: int containing the profile ID
Returns

Successful response 
[
    {
        "title": "SKU",
        "key": "sku_orders",
        "value": "SKU",
        "info": "Unique Product Identifier(Column in the Orderlist)",
        "checkbox": null,
        "checkbox_info": ""
    },
    {
        "title": "Quantity",
        "key": "quantityorders",
        "value": "Amount",
        "info": "The amount of products sold(Column in the Orderlist)",
        "checkbox": null,
        "checkbox_info": ""
    },

POST {baseURL}
async def define_labels_orderlist()

Updates the labels for the order list. For each label, the default value will be used if it has not been changed.

Parameters
  • orderlabels: 
    {
    "sku_orders": "SKU",
    "quantityorders": "Amount",
    "orderidorders": "OrderNumber",
    "purchaseday": "Sent date",
    "countryid": "Country",
    "businesstype_needed": true,
    "businesstype": "Type",
    "totalweight_needed": true,
    "totalweight": "Total Weight",
    "otherweight_needed": true,
    "otherweight": "Other Weight",
    "profile": "2"
}

Returns

Successful response 
{"message": "Labels defined successfully"}