---
updatedAt: 2025-09-10T20:59:07.000Z
agentTools:
  projectIndex: https://shipcars.readme.io/llms.txt
---

# Batch update inventory units

Update multiple inventory units

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "User Management",
    "description": "Ship.Cars User Management",
    "contact": {
      "url": "https://ship.cars",
      "email": "support@ship.cars"
    },
    "version": "1.0.0"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "oauth2",
        "flows": {
          "password": {
            "tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://ship.cars/api"
    }
  ],
  "paths": {
    "/inventory/v1/batch-update": {
      "post": {
        "tags": [
          "Batch Update API"
        ],
        "summary": "Batch update inventory units",
        "description": "Update multiple inventory units",
        "operationId": "batchUpdateUnits",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "units": {
                    "type": "array",
                    "description": "Units to be updated",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "example": "YK41K"
                        },
                        "externalId": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "CS12345"
                        },
                        "shippingDate": {
                          "type": "string",
                          "description": "Shipping date in yyyy-MM-dd format, if null will skip update",
                          "format": "date",
                          "example": "2022-03-20"
                        },
                        "buyerNumber": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "123CXS23"
                        },
                        "vin": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "123CXS2312318"
                        },
                        "year": {
                          "type": "integer",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "format": "int32",
                          "example": 2023
                        },
                        "make": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "BMW"
                        },
                        "model": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "X6"
                        },
                        "vehicleType": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "Car"
                        },
                        "lotNumber": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "123CXS23"
                        },
                        "stockNumber": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "123CXS23"
                        },
                        "operableType": {
                          "type": "string",
                          "example": "OPERABLE",
                          "enum": [
                            "OPERABLE",
                            "INOPERABLE"
                          ]
                        },
                        "trailerType": {
                          "type": "string",
                          "example": "OPEN",
                          "enum": [
                            "OPEN",
                            "ENCLOSED"
                          ]
                        },
                        "cpay": {
                          "type": "number",
                          "description": "Carrier pay, if null will skip update",
                          "format": "float",
                          "example": 132.1
                        },
                        "rate": {
                          "type": "number",
                          "description": "Vehicle rate, if null will skip update",
                          "format": "float",
                          "example": 132.55
                        },
                        "dispatchInstructions": {
                          "type": "string",
                          "description": "If null will skip from update if empty string will cleanup the column",
                          "example": "Please pick up the car gently."
                        },
                        "pickupContactId": {
                          "type": "string",
                          "description": "ID from the contact book. If null will skip from update if empty string will cleanup the column",
                          "example": "CNT-YKHTPAH2OZGVFL7GPNP35B6FCM"
                        },
                        "pickup": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "Alexander"
                            },
                            "companyName": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "MartinTLC"
                            },
                            "phone": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "5552047890"
                            },
                            "address": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "Street 56"
                            },
                            "city": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "Albion"
                            },
                            "state": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "IL"
                            },
                            "zip": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "89122"
                            }
                          }
                        },
                        "deliveryContactId": {
                          "type": "string",
                          "description": "ID from the contact book. If null will skip from update if empty string will cleanup the column",
                          "example": "CNT-YKHTPAH2OZGVFL7GPNP35B6FCM"
                        },
                        "delivery": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "Alexander"
                            },
                            "companyName": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "MartinTLC"
                            },
                            "phone": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "5552047890"
                            },
                            "address": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "Street 56"
                            },
                            "city": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "Albion"
                            },
                            "state": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "IL"
                            },
                            "zip": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "89122"
                            }
                          }
                        },
                        "customerContactId": {
                          "type": "string",
                          "description": "ID from the contact book. If null will skip from update if empty string will cleanup the column",
                          "example": "CNT-YKHTPAH2OZGVFL7GPNP35B6FCM"
                        },
                        "customer": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "Alexander"
                            },
                            "companyName": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "MartinTLC"
                            },
                            "phone": {
                              "type": "string",
                              "description": "If null will skip from update if empty string will cleanup the column",
                              "example": "5552047890"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "jobId": {
                      "type": "string",
                      "example": "YK41K"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "httpStatus": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorCode": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorMessage": {
                      "type": "string"
                    },
                    "errorDetails": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "timestamp": {
                      "type": "string",
                      "format": "date-time"
                    },
                    "httpStatus": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorCode": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "errorMessage": {
                      "type": "string"
                    },
                    "errorDetails": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```