# Return Shipments _(Realtime-enabled)_

`GET` _(Table: Return Shipment Header)_

```
eOne/core/v1.0/returnShipments
```

Read-only feed of posted purchase **return shipments**, the document produced when a purchase return order is shipped back to the vendor. It is the vendor-return counterpart of [purchaseReceipts](https://eonesolutions.github.io/eone-bc-integration/core-purchaseReceipts.md): this records the goods leaving; the financial credit is a separate [posted purchase credit memo](https://eonesolutions.github.io/eone-bc-integration/core-postedPurchaseCreditMemos.md).

## Webhook target

> **Note:** Exposed as a page (not only a query) so it can be a **webhook** target: it is change-tracked, so a subscriber is notified when a return is shipped (inserted) without polling. `integrationId` is stamped from the originating return order's Purchase Header at post time.

`$expand=returnShipmentLines` for the shipped lines (each carries its `returnReasonCode`). Read-only; filter on `number`, `returnOrderNumber`, or `buyFromVendorNumber`. `vendorAuthorizationNumber` holds the vendor's RMA authorization.

## Return Shipments fields

_API column → BC field._

**Legend**

- _(req)_ required on create
- _(res)_ resolver
- _(cur)_ currency-translated
- _(ro)_ read-only
- _(ext)_ added to this endpoint by another extension (BC field name shown; its API column name is not known here)

| API | BC field | Notes |
| --- | --- | --- |
| `id` | SystemId | BC record GUID; the OData key. _(ro)_ |
| `bcCompanyId` | bcCompanyId | The company this row belongs to - the same GUID that appears in the request URL. Present on every endpoint so a store pooling several companies can keep them apart without relying on which URL it called. _(ro)_ |
| `bcCompanyName` | bcCompanyName | The name of the company this row belongs to. _(ro)_ |
| `integrationId` | EONE Integration Id | Your external key, stamped from the return order's Purchase Header at post time. _(ro)_ |
| `number` | No. | Posted return shipment number. _(ro)_ |
| `returnOrderNumber` | Return Order No. | Originating purchase return order. _(ro)_ |
| `buyFromVendorNumber` | Buy-from Vendor No. | _(ro)_ |
| `buyFromVendorName` | Buy-from Vendor Name | _(ro)_ |
| `payToVendorNumber` | Pay-to Vendor No. | _(ro)_ |
| `payToName` | Pay-to Name | _(ro)_ |
| `postingDate` | Posting Date | _(ro)_ |
| `documentDate` | Document Date | _(ro)_ |
| `yourReference` | Your Reference | _(ro)_ |
| `vendorAuthorizationNumber` | Vendor Authorization No. | The vendor's RMA authorization number. _(ro)_ |
| `locationCode` | Location Code | _(ro)_ |
| `shipmentMethodCode` | Shipment Method Code | _(ro)_ |
| `purchaserCode` | Purchaser Code | _(ro)_ |
| `currencyCode` | Currency Code | Blank means the local currency (LCY). _(cur)_ |
| `shortcutDimension1Code` | Shortcut Dimension 1 Code | See dimensions. _(ro)_ |
| `shortcutDimension2Code` | Shortcut Dimension 2 Code | _(ro)_ |
| `dimensionSetId` | Dimension Set ID | The dimension set this record carries. Join it to the dimensionSetEntries endpoint to resolve the full set of dimension codes and values, including any beyond the eight shortcut dimension columns. _(ro)_ |
| `createdDateTime` | SystemCreatedAt | _(ro)_ |
| `lastModifiedDateTime` | SystemModifiedAt | _(ro)_ |

## Related pages

Collections nested under this endpoint:

- [Return Shipment Lines](https://eonesolutions.github.io/eone-bc-integration/core-returnShipmentLines.md)