Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Function orders/get_available_statuses (<http://<DOMAIN>>/api/orders/get_available_statuses)

Parameters:

  • token - authorization key obtained through the auth function

Response:

  • status

    • OK - statuses are unloaded successfully

    • ERROR - error

  • response.statuses - object containing statuses

    • response.statuses{i}

      • id - status id

      • title - object of status names in different languages

        • title.ua - status title in Ukrainian

        • title.en - status title in English

      • ...

    • is_successful - whether the order has been delivered

Example of POST query body

{
  "token": "c5bc0cd25647e701bc6427f3629b27b4"
}

Response example

{
    "status": "OK",
    "response": {
        "statuses": {
            "1": {
                "id": 1,
                "title": {
                    "ua": "Нове",
                    "en": "New"
                },
                "is_successful": 0
            },
            "2": {
                "id": 2,
                "title": {
                    "ua": "В обробці",
                    "en": "Processing"
                },
                "is_successful": 0
            },
            "3": {
                "id": 3,
                "title": {
                    "ua": "Доставлене",
                    "en": "Delivered"
                },
                "is_successful": 1
            },
            "4": {
                "id": 4,
                "title": {
                    "ua": "Не доставлене",
                    "en": "Canceled"
                },
                "is_successful": 0
            },
            "6": {
                "id": 6,
                "title": {
                    "ua": "Надіслане",
                    "en": "Shipping"
                },
                "is_successful": 0
            }
        }
    }
}

  • No labels