POST v1/company/shipment/share

WEB - SHARE A SHIPMENT WITH AN AUTO-GENERATED TOKEN.

Request Information

URI Parameters

None.

Body Parameters

ShipmentShareTokenRequestModel
NameDescriptionTypeAdditional information
shipment_id

UID of the shipment for which to generate a share token

string

Required

token_expire_time

Optional token expire time

date

None.

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_id": "sample string 1",
  "token_expire_time": "2018-11-15T23:42:30.5047928+03:00",
  "user_company_id": "sample string 2",
  "user_id": "sample string 3",
  "user_signature": "sample string 4"
}

Response Information

Resource Description

WEB - SHARE A SHIPMENT WITH AN AUTO-GENERATED TOKEN.

BaseMetaResultModelOfShipmentToken
NameDescriptionTypeAdditional information
response

ShipmentToken

None.

meta

Basic meta information for the operation result

MetaModel

None.

Response Format

application/json, text/json

Sample:
{
  "response": {
    "shipment_id": 2,
    "shipment_uid": "sample string 3",
    "shipment_share_token": "sample string 4",
    "token_expire_time": "2018-11-15T23:42:30.5047928+03:00"
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}