Get order statuses by groups

GET REST API request that returns list of all order statuses by groups. Response example is shown below.

Request

Request:

HTTP Method

GET

URL

Stage

https://api.stage.ananastest.com/order/api/v1/merchant-integration/outbound-orders/status-groups

Production

https://api.ananas.rs/order/api/v1/merchant-integration/outbound-orders/status-groups

HTTP Headers

Header name	Header value
Authorization	Bearer {access_token}

Response

Response is a collection of order statuses by groups.

Response Body:

Fields name	Type	Description
group	String	Suborder status group (the highest level of grouping). Values: SG_ON_HOLD, SG_PROCESSING, SG_ON_DELIVERY, SG_COMPLETED
subGroups	List<SubgroupStatuses>	List of objects which contain suborder subgroup statuses and suborder internal statuses which belong to them

GroupStatuses:

Fields name	Type	Description
subGroup	String	Suborder status subgroup (the middle level of grouping). Values: SSG_CREATED, SSG_PARTIALLY_CONFIRMED, SSG_CONFIRMED, SSG_PARTIALLY_PACKED, SSG_PACKED, SSG_TRANSPORT_INITIATED, SSG_ON_DELIVERY, SSG_DELIVERED, SSG_CANCELLED, SSG_NOT_DELIVERED
statuses	List<String>	List which contains suborder internal statuses. Values: CREATED, PENDING, NOT_READY, CANCELLED, MISSING_ITEMS, CANCELLED_BY_JOB, CANCELLED_BY_CUSTOMER, CANCELLED_BY_MERCHANT, CANCELLED_BY_EMPLOYEE, PARTIALLY_CONFIRMED, CONFIRMED, PACKING_INITIATED, PARTIALLY_PACKED, PACKED, READY_FOR_COLLECTION, TERMINATED, COLLECTED, ON_DELIVERY, ATTEMPTED_DELIVERY, REJECTED_DELIVERY, CUSTOMER_ADDRESS_INVALID, RETURN_TO_SELLER, RETURN_TO_SELLER_UNVERIFIED, RETURN_TO_SELLER_CANCELLED, RETURNED_TO_SELLER, REDIRECTED_DELIVERY, DELAYED_DELIVERY, DAMAGED, DAMAGED_UNVERIFIED, DAMAGED_CANCELLED, LOST, LOST_UNVERIFIED, LOST_CANCELLED, DELIVERED, COLLECTED_PUDO, ON_DELIVERY_PUDO, DELIVERED_BY_CARRIER_PUDO, DELIVERED_PUDO, ATTEMPTED_DELIVERY_PUDO, REJECTED_DELIVERY_PUDO, ADDRESS_INVALID_PUDO, DAMAGED_AT_PUDO, DAMAGED_AT_PUDO_UNVERIFIED, DAMAGED_AT_PUDO_CANCELLED, LOST_AT_PUDO, LOST_AT_PUDO_UNVERIFIED, LOST_AT_PUDO_CANCELLED, COMPLETED_PUDO, COLLECTED_LOCKER, ON_DELIVERY_LOCKER, DELIVERED_LOCKER, COMPLETED_LOCKER

Example of response:

Click to copy

Success!

   [
   {
      "group":"SG_ON_HOLD",
      "subGroups":[
         {
            "subGroup":"SSG_CREATED",
            "statuses":[
               "CREATED"
            ]
         }
      ]
   },
   {
      "group":"SG_PROCESSING",
      "subGroups":[
         {
            "subGroup":"SSG_PARTIALLY_CONFIRMED",
            "statuses":[
               "PARTIALLY_CONFIRMED",
               "PENDING"
            ]
         },
         {
            "subGroup":"SSG_CONFIRMED",
            "statuses":[
               "CONFIRMED",
               "PACKING_INITIATED"
            ]
         },
         {
            "subGroup":"SSG_PARTIALLY_PACKED",
            "statuses":[
               "PARTIALLY_PACKED"
            ]
         },
         {
            "subGroup":"SSG_PACKED",
            "statuses":[
               "PACKED"
            ]
         },
         {
            "subGroup":"SSG_TRANSPORT_INITIATED",
            "statuses":[
               "READY_FOR_COLLECTION"
            ]
         }
      ]
   },
   {
      "group":"SG_ON_DELIVERY",
      "subGroups":[
         {
            "subGroup":"SSG_ON_DELIVERY",
            "statuses":[
               "COLLECTED",
               "ON_DELIVERY",
               "ATTEMPTED_DELIVERY",
               "REDIRECTED_DELIVERY",
               "DELAYED_DELIVERY",
               "COLLECTED_PUDO",
               "ON_DELIVERY_PUDO",
               "DELIVERED_PUDO",
               "DELIVERED_BY_CARRIER_PUDO",
               "COLLECTED_LOCKER",
               "ON_DELIVERY_LOCKER",
               "DELIVERED_LOCKER"
            ]
         }
      ]
   },
   {
      "group":"SG_COMPLETED",
      "subGroups":[
         {
            "subGroup":"SSG_DELIVERED",
            "statuses":[
               "DELIVERED",
               "COMPLETED_PUDO",
               "COMPLETED_LOCKER"
            ]
         },
         {
            "subGroup":"SSG_CANCELLED",
            "statuses":[
               "CANCELLED",
               "CANCELLED_BY_JOB",
               "CANCELLED_BY_CUSTOMER",
               "CANCELLED_BY_MERCHANT",
               "CANCELLED_BY_EMPLOYEE",
               "TERMINATED",
               "MISSING_ITEMS"
            ]
         },
         {
            "subGroup":"SSG_NOT_DELIVERED",
            "statuses":[
               "REJECTED_DELIVERY",
               "CUSTOMER_ADDRESS_INVALID",
               "RETURN_TO_SELLER",
               "RETURN_TO_SELLER_CANCELLED",
               "RETURN_TO_SELLER_UNVERIFIED",
               "RETURNED_TO_SELLER",
               "DAMAGED",
               "DAMAGED_CANCELLED",
               "DAMAGED_UNVERIFIED",
               "LOST",
               "LOST_CANCELLED",
               "LOST_UNVERIFIED",
               "ATTEMPTED_DELIVERY_PUDO",
               "REJECTED_DELIVERY_PUDO",
               "ADDRESS_INVALID_PUDO",
               "DAMAGED_AT_PUDO",
               "DAMAGED_AT_PUDO_CANCELLED",
               "DAMAGED_AT_PUDO_UNVERIFIED",
               "LOST_AT_PUDO",
               "LOST_AT_PUDO_CANCELLED",
               "LOST_AT_PUDO_UNVERIFIED"
            ]
         }
      ]
   }
]