POST v1/company/shipment/share

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

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
shipment_id	UID of the shipment for which to generate a share token	string	Required
shipment_stop_addresses		Collection of integer	None.
shipment_documents		Collection of integer	None.
send_shipment_feedback		boolean	None.
shared_email_addresses		string	None.
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",
  "shipment_stop_addresses": [
    1,
    2
  ],
  "shipment_documents": [
    1,
    2
  ],
  "send_shipment_feedback": true,
  "shared_email_addresses": "sample string 3",
  "token_expire_time": "2024-11-25T22:35:50.6205554+03:00",
  "user_company_id": "sample string 4",
  "user_id": "sample string 5",
  "user_signature": "sample string 6"
}

Response Information

Resource Description

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

BaseMetaResultModelOfShipmentToken

Name	Description	Type	Additional 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": "2024-11-25T22:35:50.6235554+03:00",
    "send_shipment_feedback": true,
    "shared_email_addresses": "sample string 7"
  },
  "meta": {
    "status_code": 1,
    "status_message": "sample string 2"
  }
}