PGS360 API

Create a new B2B outbound order

Submits a new Business-to-Business (B2B) outbound order to PGS360 for warehouse fulfilment. The order instructs the warehouse to pick, pack, and ship goods to a retailer, distributor, or commercial consignee. The request must include at least one line item in `b2B_Item`. Each item must reference a SKU that has already been registered in the system via the SKU API. On success the API returns a `B2BDetailsLoadedResponse` containing the PGS internal order ID and a per-line confirmation of quantities loaded into the warehouse management system. Any line-level validation warnings are surfaced in the `msg` field of each detail item. **Authentication:** Bearer token obtained from `POST /api/Security/Token` must be included in the `Authorization` header.

Request Body

Responses

Update an existing B2B outbound order

Updates a B2B outbound order that has not yet been shipped. The payload structure is identical to the create (`POST`) operation; the order is identified by the `orderNo` field in the request body. Only orders in an open/unshipped status can be modified. Attempting to update an order that is already in a picked, packed, or shipped state will return an error. If you need to cancel a shipped order, contact PGS360 operations directly. A successful update returns a `B2BDetailsLoadedResponse` reflecting the revised line quantities.

Request Body

Responses

Cancel an open B2B outbound order

Cancels and removes an open B2B outbound order from the warehouse queue. The `OrderNo` path parameter must match the customer-assigned order number (`orderNo`) that was supplied when the order was created. Cancellation is only possible while the order remains in an open status and has not been picked or shipped. Attempting to cancel an in-progress or completed order will result in an error response.

Parameters

Responses

Get current status of a B2B order

Returns the current processing status of a B2B outbound order identified by the customer order number (`OrderNo`). The response includes a human-readable `status` string, an integer `statusCode`, and a `pgsOrderID` (PGS360's internal identifier). The `items` array provides per-line detail including the warehouse code, quantities uploaded, and any informational messages. Use this endpoint to poll order progress after creation or to diagnose upload issues before shipment.

Parameters

Responses

List B2B orders shipped on a date

Returns a list of B2B outbound orders that were shipped on the specified date. The `Date` path parameter must be in `yyyy-MM-dd` format (e.g., `2024-03-15`). The response is an array of `B2BShippedResponse` objects, each containing full shipment details including invoice information, tracking numbers, carrier, line items shipped, SSCC pallet labels, and package/pallet counts. Use this endpoint for daily reconciliation or to trigger downstream invoicing and EDI processes.

Parameters

Responses

Get B2B shipment details by order number

Returns the full shipment record for a specific B2B outbound order identified by the customer order number (`OrderNo`). This endpoint is useful when you know the order number and want to retrieve tracking, invoice, and line-item shipment data without filtering by date. If the order has not yet been shipped the response will be empty or return an appropriate status.

Parameters

Responses

List simplified B2B shipments by date

Returns a simplified list of B2B shipments for a given date in `yyyy-MM-dd` format. Unlike `/OrdersShipped/{Date}`, this endpoint returns a `ShippedGeneralResponse` array which provides a lightweight summary (PGS order ID, order number, shipped date, carrier, service, tracking number, and per-line SKU quantities) without the full invoice detail. Suitable for building shipment dashboards or triggering lightweight notification workflows.

Parameters

Responses

Retrieve all open B2B outbound orders

Returns a list of all B2B outbound orders currently in an open (not yet shipped) status across all warehouses associated with the authenticated customer account. Each record in the `B2BOrdersOpen` array includes the PGS internal order number, the customer sales order and purchase order references, consignee details, destination, line item count, pallet and case counts, and scheduling dates (routed date and scheduled pick-up date). Use this endpoint to monitor your fulfilment queue and identify any stalled or overdue orders.

Responses

Get simplified B2B shipment by order number

Returns a simplified `ShippedGeneralResponse` for a specific B2B outbound order identified by the customer order number. This provides summary-level shipment information (tracking, carrier, service type, and per-line quantities) for a single order, without the full invoice detail available from `/OrdersShipped/SO/{OrderNo}`.

Parameters

Responses

Create a new B2C outbound order

Submits a new Business-to-Consumer (B2C) outbound order (e.g., an eCommerce direct-to-consumer shipment) to the PGS360 warehouse for fulfilment. The order identifies the end consumer's shipping address and lists the SKUs and quantities to be shipped. At least one item must be included in `b2C_Item`. Each SKU must be pre-registered via the SKU API. The `carrier` and `serviceType` fields control which carrier and service level the warehouse will use; if omitted, the warehouse's default is applied. Returns a `B2CShippedResponse`-style confirmation on success, including the PGS internal order ID.

Request Body

Responses

Update an existing B2C outbound order

Modifies a B2C outbound order that has not yet been shipped. The order is identified by the `orderNumber` field in the request body. All editable fields (address, carrier, items, etc.) may be updated in the same payload. Only open orders can be updated. Returns a confirmation response on success. Attempting to update an order already in progress or shipped will result in an error.

Request Body

Responses

List B2C orders shipped on a date

Returns full shipment records for all B2C outbound orders shipped on the specified date. The `Date` path parameter must be in `yyyy-MM-dd` format. Each `B2CShippedResponse` item contains the customer order number, PGS internal ID, shipping timestamps, carrier and service type, tracking number, consignee name, and per-line SKU/quantity/lot detail. Use this for end-of-day reconciliation, customer notification workflows, or return-merchandise-authorisation (RMA) pre-processing.

Parameters

Responses

Get B2C shipment details by order number

Returns the full `B2CShippedResponse` for a single B2C order identified by the customer-assigned order number (`OrderNo`). Useful for retrieving tracking and shipment confirmation data for a specific consumer order after it has been dispatched.

Parameters

Responses

List simplified B2C shipments by date

Returns a lightweight `ShippedGeneralResponse` array for all B2C orders shipped on the given date (`yyyy-MM-dd`). Provides PGS order ID, order number, shipped date, carrier, service type, tracking number, and per-line quantities without the full consumer detail present in `/OrdersShipped/{Date}`.

Parameters

Responses

Get simplified B2C shipment by order number

Returns a simplified `ShippedGeneralResponse` for a single B2C order identified by the customer order number. Provides summary shipment data (tracking, carrier, items shipped) without full invoice detail.

Parameters

Responses

Get current status of a B2C order

Returns the current processing status of a B2C outbound order identified by the customer-assigned order number (`OrderNumber`). The response includes the customer order number, PGS internal ID, a human-readable `status` string, a `timeStamp` of the last status change, and an `items` array with per-line SKU and quantity detail. Use this endpoint to check whether an order is open, in picking, packed, or shipped.

Parameters

Responses

Cancel an open B2C outbound order

Cancels and removes an open B2C outbound order from the warehouse queue. The `OrderNumber` path parameter must match the customer-assigned order number supplied at creation time. Only orders in open status that have not yet been picked or shipped can be cancelled via this endpoint. Contact PGS360 operations for orders already in progress.

Parameters

Responses

Retrieve all open B2C outbound orders

Returns a list of all B2C outbound orders in an open (not yet shipped) status for the authenticated customer account. Each `B2COrdersOpen` record includes the customer order number, PGS internal ID, creation timestamp, line item count, current status, consignee name, destination, warehouse, and assigned carrier and service type. Use this to monitor the live fulfilment queue for consumer orders.

Responses

Register or update a customer ship-to address

Creates or updates a ship-to address record in the PGS360 system for the authenticated customer. This address book entry can then be referenced in outbound order requests to avoid repeating full address details on every order. All fields except `street2`, `phone`, and `email` are required. The `countryCode` must be a valid ISO 3166-1 alpha-2 or alpha-3 country code consistent with the convention used in your outbound order requests.

Request Body

Responses

Create a new inbound purchase order

Submits a new inbound purchase order (PO) / Advance Shipment Notice (ASN) to PGS360, instructing the warehouse to expect and receive stock from a vendor. The request must include the vendor's details, the expected ship-to warehouse address, and at least one line item in `inbound_Item`. The `purchaseOrderNo` is the primary key used in all subsequent status and receipt queries. On success the API returns an `InboundDetailsLoadedResponse` containing a per-line confirmation of quantities loaded, the PGS internal inbound ID, and any informational messages. SKUs referenced in line items must already exist in the PGS360 item master.

Request Body

Responses

Update an existing inbound purchase order

Modifies an existing inbound purchase order that has not yet been received. The order is identified by `purchaseOrderNo` in the request body. All fields may be updated in the same payload. Only POs in open/pending status can be modified. Returns an `InboundDetailsLoadedResponse` reflecting the revised lines.

Request Body

Responses

Cancel an open inbound purchase order

Cancels an open inbound purchase order identified by the `PurchaseOrderNo` path parameter. The value must match the `purchaseOrderNo` supplied at creation. Only orders that have not yet been received (or partially received) can be cancelled through this endpoint. Contact PGS360 operations for orders already in a receiving workflow.

Parameters

Responses

Get status of an inbound purchase order

Returns the current status and receipt detail for an inbound PO identified by `PurchaseOrderNo`. The `InboundStatusResponse` includes a human-readable status, a numeric status code, vendor and customer account identifiers, warehouse code, received item receipts grouped by receipt number and date, and the originally requested line items for comparison. Use this endpoint to confirm that stock has been received, verify receipt quantities, and detect discrepancies between ordered and received units.

Parameters

Responses

List inbound POs received on a date

Returns full receipt records for all inbound purchase orders received on the specified date. The `Date` path parameter must be in `yyyy-MM-dd` format. Each `InboundReceivedResponse` contains the PO numbers, vendor and customer identifiers, warehouse code, receipt details grouped by receipt number (including quantities received and lot/serial numbers), and the originally ordered line items.

Parameters

Responses

Get receipt details for a specific PO

Returns the full `InboundReceivedResponse` for a single inbound purchase order identified by the `PO` path parameter (the customer's purchase order number). Provides the same comprehensive receipt detail as `/OrdersReceived/{Date}` but scoped to one PO. Useful for reconciling a specific inbound shipment against your ERP without needing to know the receipt date.

Parameters

Responses

List simplified inbound receipts by date

Returns a simplified `ReceivedGeneralResponse` array for all inbound POs that were received on the given date (`yyyy-MM-dd`). Each record provides the order number, a closed/open indicator, and per-receipt item lines with SKU, lot number, and quantities received. Use this as a lightweight alternative to `/OrdersReceived/{Date}` when full vendor and customer header detail is not needed.

Parameters

Responses

Get simplified receipt detail by PO number

Returns a simplified `ReceivedGeneralResponse` for a single inbound purchase order identified by the `orderNo` path parameter. Provides receipt-grouped item lines (SKU, lot, quantity) and a closed indicator without the full header detail of the `/OrdersReceived/PO/{PO}` variant.

Parameters

Responses

Query current on-hand inventory levels

Returns current inventory stock levels for SKUs held at PGS360 warehouses. Results can be filtered and paginated using optional query parameters: - `SKU` — filter to a specific stock-keeping unit code. - `startposition` — zero-based offset for pagination (default: 0). - `maxresults` — maximum number of records to return per call. Each `InventoryDetailsResponse` record provides the SKU code, current stock level (units on hand), warehouse identifier, lot number (if lot-controlled), and inventory status (e.g., available, quarantine, damaged). If `SKU` is omitted, all SKUs for the authenticated account are returned subject to the pagination parameters. Use `startposition` and `maxresults` together to page through large inventories.

Parameters

Responses

Obtain a Bearer authentication token

Authenticates the caller and returns a time-limited Bearer token for use in the `Authorization` header of all subsequent API requests. Supply your PGS360-issued `userId` and `passwd` credentials in the request body. The response includes the `access_token` string, the token type (`Bearer`), and the number of seconds until expiry (`expires_in`). Tokens should be cached and reused until they near expiry to avoid unnecessary re-authentication overhead. When a token expires, call this endpoint again to obtain a fresh one.

Request Body

Responses

Create a new SKU in the item master

Registers a new Stock-Keeping Unit (SKU) in the PGS360 warehouse item master. SKUs must be created before they can be referenced in inbound or outbound orders. The request captures all physical and handling attributes required for warehouse operations: dimensions, weight, units of measure, case and pallet configuration, hazmat classifications, lot control settings, and storage category. Returns a confirmation on success. If the SKU already exists, use `PUT /api/Sku` to update it.

Request Body

Responses

Update an existing SKU in the item master

Updates the attributes of an existing SKU in the PGS360 item master. The SKU to update is identified by the `sku` field in the request body. All fields present in the `SkuRequest` schema may be updated. Changes take effect for subsequent inbound and outbound order processing. Changes to physical dimensions or hazmat flags may affect carrier selection and storage slotting within the warehouse.

Request Body

Responses

Retrieve item master details for a SKU

Returns the current item master record for the SKU identified by the `SKU` path parameter. The response includes all attributes registered against the SKU: descriptions, UPC codes, physical dimensions, weight, unit of measure, packing configuration, hazmat flags, lot-control setting, and storage/cycle-count categories. Use this endpoint to verify that a SKU's attributes are correct before submitting orders, or to audit the item master after an update.

Parameters

Responses

Register or update a vendor address

Creates or updates a vendor address record in the PGS360 system. Vendor addresses can be pre-registered here so they can be referenced in inbound purchase order requests without repeating the full address on every PO submission. All fields except `street2`, `phone`, and `email` are required. The `countryCode` must be a valid ISO 3166-1 alpha-2 or alpha-3 country code consistent with the convention used in your inbound order requests.

Request Body

Responses