shipments

Assign user to shipments

Changed on

Assigns a user to one or more shipments. You can assign a single user to up to 500 shipments at once.

post/v1/shipments/user

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/shipments/user
  • Auth: API key in header API-Key

Request body

shipment_idsSeId[] required

Array of shipment IDs to assign the user to

user_idstring uuid required

The ID of the user to assign to the shipments

Example request

{
  "shipment_ids": [
    "se-202902255",
    "se-202902256"
  ],
  "user_id": "a2df9fa5-b7ee-467f-be4e-9c660542c187"
}

Response

The request was a success.

shipment_idsSeId[]

Array of shipment IDs that were assigned to the user

user_idstring uuid

The ID of the user assigned to the shipments

Example response

{
  "shipment_ids": [
    "se-202902255",
    "se-202902256"
  ],
  "user_id": "a2df9fa5-b7ee-467f-be4e-9c660542c187"
}

Changes

  • e998dffc42beRevision changes
    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

  • 020f57d6f5b8Revision changes
    • breaking

      the / request property's minLength was increased from 0 to 1

    • breaking

      added the pattern ^se(-[a-z0-9]+)+$ to the request property /

    • breaking

      the / request property type changed from no type to string

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to string for status

    • warning

      removed from the / request property allOf list

    • warning

      the / request property's maxLength was set to 25

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      the / response's property pattern ^se(-[a-z0-9]+)+$ was added for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status