POST v1/admin/shipment/state

ADMIN - Change shipment state.

Request Information

URI Parameters

None.

Body Parameters

AdminShipmentChangeStateRequestModel
NameDescriptionTypeAdditional information
shipment_company_id

string

Required

shipment_id

string

Required

shipment_state

integer

Required

user_company_id

Company UID of the active user

string

Required

Data type: Text

user_id

User ID (GUID)

string

Required

Data type: Text

user_signature

MD5 hash signature for the active user to validate the request

string

Required

Data type: Text

Request Format

application/json, text/json

Sample:
{
  "shipment_company_id": "sample string 1",
  "shipment_id": "sample string 2",
  "shipment_state": 3,
  "user_company_id": "sample string 4",
  "user_id": "sample string 5",
  "user_signature": "sample string 6"
}

Response Information

Resource Description

ADMIN - Change shipment state.

BaseMetaResultModel
NameDescriptionTypeAdditional information
meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}