Unassign User from Order

Unassigns a user from an order.

Requirements:

  • You'll need an orderId to make this API call.
  • Find that orderId in your Response from the Create/Update Order call if you are creating the orders via OpenAPI.
  • If you’re importing orders from a marketplace, you can list orders and find the orderId using one of the endpoints in a List Orders By Tag call.

The body of this request should specify the following attributes:

Name Data Type Description
orderId Array of numbers Identifies an order or set of orders that will have the user unassigned.

orderId = number

NOTE: If ANY of the orders within the array are not found, then no orders will have their users unassigned.

Required

Example Request

POST /orders/unassignuser HTTP/1.1
Host: ssapi.shipstation.com
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json

{
  "orderIds": [
    123456789,
    12345679
  ]
}

Example Response

{
  "success": true,
  "message": "User unassigned successfully."
}