Skip to content
ShipperOne Developer Portal

Sync stock items

POST
/V1/stockItems

Sync stock quantities for a batch of items by SKU and warehouse code. Used by ERPs and fulfillment partners to keep ShipperOne inventory in sync.

Request Body

Section titled “Request Body ”
object
stock_items
required
Array<object>
object
warehouse_code
required
string
sku
required
string
qty
required
integer
Example generated
{
  "stock_items": [
    {
      "warehouse_code": "example",
      "sku": "example",
      "qty": 1
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

200 Success.

Array<object>
object
warehouse_code
required
string
sku
required
string
qty
required
integer
Example generated
[
  {
    "warehouse_code": "example",
    "sku": "example",
    "qty": 1
  }
]

400

Section titled “400 ”

400 Bad Request

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

401

Section titled “401 ”

401 Unauthorized

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

500

Section titled “500 ”

Internal Server error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}

default

Section titled “default ”

Unexpected error

object
message
required

Error message

string
errors

Errors list

Array<object>

Error details

object
message

Error message

string
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
code

Error code

integer
parameters

Error parameters list

Array<object>

Error parameters item

object
resources

ACL resource

string
fieldName

Missing or invalid field name

string
fieldValue

Incorrect field value

string
trace

Stack trace

string
Example generated
{
  "message": "example",
  "errors": [
    {
      "message": "example",
      "parameters": [
        {
          "resources": "example",
          "fieldName": "example",
          "fieldValue": "example"
        }
      ]
    }
  ],
  "code": 1,
  "parameters": [
    {
      "resources": "example",
      "fieldName": "example",
      "fieldValue": "example"
    }
  ],
  "trace": "example"
}