# ShipStream Developer Center ## Docs - [Authentication](https://docs.shipstream.io/global-api/authentication.md) - [List total inventory levels](https://docs.shipstream.io/global-api/endpoint/v1/inventory/levels/total/get.md): Returns a list of `TotalLevel` objects showing aggregated inventory quantities across all warehouses for each product. - [List warehouse inventory levels](https://docs.shipstream.io/global-api/endpoint/v1/inventory/levels/warehouse/get.md): Retrieve inventory levels grouped by warehouse for each product. This endpoint returns warehouse-specific inventory data with quantity information per product per warehouse. - [Create Product or Packaging](https://docs.shipstream.io/global-api/endpoint/v1/inventory/products/post.md): Creates a new `Product` or `PackagingFeature` in ShipStream according to the request body. - [List all Products and Packaging](https://docs.shipstream.io/global-api/endpoint/v1/inventory/products/{type}/get.md): Returns a list of [Products](https://help.shipstream.io/article/8b9rvho130-products) (SKUs) or [Packaging Features](https://help.shipstream.io/article/cxyprn6ysa-packaging-features) specified by the `type` path parameter and according to the request body. - [Get Product or Packaging](https://docs.shipstream.io/global-api/endpoint/v1/inventory/products/{type}/{id}/get.md): Returns a single `Product` or `Packaging*` object specified by its `id` & `type` path parameter. - [Update Product or Packaging](https://docs.shipstream.io/global-api/endpoint/v1/inventory/products/{type}/{id}/put.md): Updates a `Product` in ShipStream specified by its `id` path parameter and according to the request body. - [List all Warehouses](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/get.md): Returns a list of `Warehouse` objects. - [Create Warehouse](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/post.md): Creates a new `Warehouse` in ShipStream according to the request body. - [Delete Warehouse](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/delete.md): Deletes a `Warehouse` specified by its `id` path parameter. - [Get one Warehouse](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/get.md): Returns a single `Warehouse` object specified by its `id` path parameter. - [Batch update Locations](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/locations/batch/post.md): Creates or updates a `Location` collection specified by a warehouse `id` path parameter and according to the request body. - [List all Locations](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/locations/get.md): Returns a list of `Location` objects specified by a warehouse `id` path parameter. - [Create Location](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/locations/post.md): Creates a new `Location` specified by a warehouse `id` and according to the request body. - [Delete Location](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/delete.md): Deletes an existing Location specified by the warehouse `id` and `location_id` path parameters. - [Get one Location](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/get.md): Returns a single `Location` object specified by the warehouse `id` and `location_id` path parameters. - [Update Location](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/put.md): Updates a `Location` specified by the warehouse `id` and `location_id` path parameters and according to the request body. - [Get Location by Label](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/get.md): Returns a single `Location` object specified by the warehouse `id` and location `label` path parameters. - [Update Warehouse](https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/{id}/put.md): Updates a `Warehouse` specified by its `id` path parameter and according to the request body. - [List all Deliveries](https://docs.shipstream.io/global-api/endpoint/v1/receiving/{type}/get.md): Returns a list of `ASN`, `RMA`, or `Other` objects specified by the `type` path parameter. - [Get one Delivery](https://docs.shipstream.io/global-api/endpoint/v1/receiving/{type}/{id}/get.md): Returns a single `ASN`, `RMA`, or `Other` object specified by its `type` & `id` path parameters. - [List all Orders](https://docs.shipstream.io/global-api/endpoint/v1/shipping/orders/get.md): Returns a list of `Order` objects. - [Method not allowed](https://docs.shipstream.io/global-api/endpoint/v1/shipping/orders/massUpdate/get.md): GET method is not allowed for this endpoint. Use POST instead. - [Mass update orders](https://docs.shipstream.io/global-api/endpoint/v1/shipping/orders/massUpdate/post.md): Updates a batch of orders specified by and according to the request body. - [Get one Order](https://docs.shipstream.io/global-api/endpoint/v1/shipping/orders/{id}/get.md): Returns a single `Order` object specified by an order `id` path parameter. - [List all Shipments](https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/get.md): Returns a list of `Shipment` objects. - [Get one Shipment](https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/{id}/get.md): Returns a single `Shipment` object specified by a shipment `id` path parameter. - [Pack Shipment](https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/{id}/pack/post.md): This endpoint can be used in multiple modes of operation and in all cases operates on a `Shipment` specified by its `id` path parameter. - [Pick Shipment](https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/{id}/pick/post.md): Completes some or all picks for the `Shipment` specified by its `id` path parameter. - [Process Shipment](https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/{id}/process/post.md): Processes a `Shipment`, specified by its `id` path parameter, in the “new” status so that it is reserved to specific stock locations and is ready to be picked. - [Get Shipment Reservations](https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/{id}/reservations/get.md): Returns the assigned reservations (pick locations) for a shipment in Picking status. - [Mark Shipment as Shipped](https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/{id}/shipped/post.md): Marks a `Shipment` in the "packed" status as shipped, specified by its `id` path parameter. - [List all Merchants](https://docs.shipstream.io/global-api/endpoint/v1/system/merchants/get.md): Returns a list of `Merchant` objects sorted ascending by `id` unless specified otherwise. - [Healthcheck](https://docs.shipstream.io/global-api/endpoint/v1/system/status/get.md): Endpoint that is inexpensive and can be used to determine things like: - The API is "up" or some other status - The request has valid authentication or not - What version of the software is running - If there are any ongoing notices or issues reported - The oldest API version supported - The newest… - [List all User Roles](https://docs.shipstream.io/global-api/endpoint/v1/system/userRoles/{type}/get.md): Returns a list of `UserRole` objects specified by its `type` path parameter. - [Delete User Role](https://docs.shipstream.io/global-api/endpoint/v1/system/userRoles/{type}/{id}/delete.md): Deletes an existing `UserRole` specified by its `type` and `id` path parameters. - [Get one User Role](https://docs.shipstream.io/global-api/endpoint/v1/system/userRoles/{type}/{id}/get.md): Returns a single `UserRole` object specified by its `type` and `id` path parameters. - [Update one User Role](https://docs.shipstream.io/global-api/endpoint/v1/system/userRoles/{type}/{id}/put.md): Update an existing User Role by internal ID. - [List all Users](https://docs.shipstream.io/global-api/endpoint/v1/system/users/{type}/get.md): Returns a list of `User` objects of a specified user `type` path parameter. - [Delete User](https://docs.shipstream.io/global-api/endpoint/v1/system/users/{type}/{id}/delete.md): Deletes an existing `User` specified by its `type` and `id` path parameters. - [Get one User](https://docs.shipstream.io/global-api/endpoint/v1/system/users/{type}/{id}/get.md): Returns a single `User` object specified by its `type` and `id` path parameters. - [Update one User](https://docs.shipstream.io/global-api/endpoint/v1/system/users/{type}/{id}/put.md): Updates an existing `User` specified by its `type` and `id` path parameters and according to the request body. - [Filtering Syntax](https://docs.shipstream.io/global-api/filtering-syntax.md) - [Introduction](https://docs.shipstream.io/global-api/introduction.md) - [Paging Parameters](https://docs.shipstream.io/global-api/paging-parameters.md) - [Response Codes and Errors](https://docs.shipstream.io/global-api/response-codes-errors.md) - [Selecting Fields](https://docs.shipstream.io/global-api/selecting-fields.md) - [Sorting Syntax](https://docs.shipstream.io/global-api/sorting-syntax.md) - [Versions](https://docs.shipstream.io/global-api/versions.md) - [Find Your URL](https://docs.shipstream.io/home/find-your-url.md) - [Authentication](https://docs.shipstream.io/merchant-api/authentication.md): Learn about the authentication methods for the Merchant API. - [Bill of Materials](https://docs.shipstream.io/merchant-api/bom.md) - [Brand](https://docs.shipstream.io/merchant-api/brand.md) - [Delivery](https://docs.shipstream.io/merchant-api/delivery.md) - [Delivery Label](https://docs.shipstream.io/merchant-api/delivery-label.md) - [Enumerations](https://docs.shipstream.io/merchant-api/enumeration.md) - [Import](https://docs.shipstream.io/merchant-api/import.md) - [Import Formats](https://docs.shipstream.io/merchant-api/import-formats.md) - [Introduction](https://docs.shipstream.io/merchant-api/introduction.md): Learn the basics of using the Merchant API. - [Inventory](https://docs.shipstream.io/merchant-api/inventory.md) - [Order](https://docs.shipstream.io/merchant-api/order.md) - [Order Custom Fields](https://docs.shipstream.io/merchant-api/order-custom-field.md) - [Packing Instructions](https://docs.shipstream.io/merchant-api/order-instruction.md) - [Product](https://docs.shipstream.io/merchant-api/product.md) - [Product Media](https://docs.shipstream.io/merchant-api/product-media.md) - [Rate Limits](https://docs.shipstream.io/merchant-api/rate-limits.md): Understand the rate and concurrency limits enforced on the Merchant API. - [Rating](https://docs.shipstream.io/merchant-api/rating.md) - [Search Filters](https://docs.shipstream.io/merchant-api/search-filters.md) - [Search Options](https://docs.shipstream.io/merchant-api/search-options.md) - [Shipment](https://docs.shipstream.io/merchant-api/shipment.md) - [Shipment Custom Fields](https://docs.shipstream.io/merchant-api/shipment-custom-field.md) - [Package](https://docs.shipstream.io/merchant-api/shipment-package.md) - [Shipping Methods](https://docs.shipstream.io/merchant-api/shipping-methods.md) - [Stock Movements](https://docs.shipstream.io/merchant-api/stock-movement.md) - [Third Party Billing](https://docs.shipstream.io/merchant-api/third-party-billing-group.md) - [Units of Measure](https://docs.shipstream.io/merchant-api/units-of-measure.md) - [Warehouse](https://docs.shipstream.io/merchant-api/warehouse.md) - [Webhook](https://docs.shipstream.io/merchant-api/webhook.md) - [Webhook Topics](https://docs.shipstream.io/merchant-api/webhook-topics.md) ## OpenAPI Specs - [openapi](https://docs.shipstream.io/global-api/openapi.json) ## Optional - [Knowledge Base](https://help.shipstream.io) - [Release Notes](https://help.shipstream.io/article/fzz2g8rxhs-release-notes-overview) - [Warehouse Designer](https://flow.shipstream.io)