---
updatedAt: 2025-06-25T13:24:10.000Z
agentTools:
projectIndex: https://developers.evrythng.com/llms.txt
---
# Shipment Notices
Enterprise Feature
This feature is only available to customers with an enterprise Platform subscription. Please [get in touch](https://evrythng.com/contact-us/) to discuss enabling it on your account.
The Shipment Notice API allows solution developers to record their shipment notice documents (similar to Advance Shipment Notices) within an EVRYTHNG account, enabling coordinated functionality with the Purchase Orders API. A shipment notice resource details a shipment to be sent, including type, container contents, and important dates.
## When reading, updating, or deleting a shipment notice, either the `id` or `asnId` property may be used.
**API Status**
Beta:
`/shipmentNotices`
`/shipmentNotices/{shipmentNoticeId}`
-------------------------------------
## ShipmentNoticeDocument Data Model
An object representing a shipment notice.
```text
.id (string, read-only)
The ID of this resource.
.asnId (string, required)
ID of the associated shipment notice.
.description (string)
Friendly description of this resource.
.createdAt (integer, read-only)
Timestamp when the resource was created.
.updatedAt (integer, read-only)
Timestamp when the resource was updated.
.tags (array of string)
Array of string tags associated with this resource.
.customFields (CustomFieldsDocument)
Object of case-sensititve key-value pairs of custom fields
associated with the resource.
.identifiers (IdentifiersDocument)
Various identifiers (EPC, GTIN, etc.) as a JSON object with
one or more key-value pairs.
.version (string)
Identifies the current version of the shipment, the default
value is '1'
.status (string, required, one of 'open', 'closed', 'cancelled')
The status of the shipment
.purchaseOrderId (string)
A reference to an associated purchase order, applies to all contents
if specified
.issueDate (string, required)
The date the shipment was issued on
.deliveryDate (string)
The date the shipment is due to be delivered
.transportation (string)
The type of transportation
.parties (array of ShipmentNoticePartyDocument, max. 3, required)
The parties involved in the shipment
.contents (array of ShipmentNoticeContentDocument, max. 1000)
Array of products in the shipment and their quantites.
```
See also: [`ShipmentNoticePartyDocument`](#section-shipmentnoticepartydocument-data-model), [`ShipmentNoticeContentDocument`](#section-shipmentnoticecontentdocument-data-model)
### Filterable Fields
This resource type can be filtered using the following fields and operators.
***
## ShipmentNoticePartyDocument Data Model
A party involved in this shipment notice.
```text
.id (string)
Colon separated identifier with format of 'type:value'
.name (string)
Display name for the party
.type (string, one of 'ship-from', 'ship-to', 'bill-to')
The party type defines what involvement the identified party
has in this shipment notice
.identifiers (IdentifiersDocument)
Various identifiers (EPC, GTIN, etc.) as a JSON object with
one or more key-value pairs.
.address (AddressDocument)
An object representing a street address.
```
## See also: `AddressDocument`
## ShipmentNoticeContentDocument Data Model
A product included in this shipment notice.
```text
.product (string, required)
The product identifier. Colon separated identifier with
format of 'type:value'
.quantity (integer, required)
The quantity of this product included in this shipment.
.purchaseOrderId (string)
A reference to an associated purchase order, cannot co-exist with a
purchase order id that has been defined in the shipment notice
```
***
## Create a shipment notice
Create a new shipment notice resource.
```javascript
const payload = {
asnId: '9827429837429823828273',
version: '1',
purchaseOrderId: '4700990774',
issueDate: '2019-06-19T16:39:57-08:00',
transportation: 'Expedited Freight',
parties: [
{
id: 'gs1:414:01251',
type: 'ship-from'
},
{
name: 'The Landmark, Shop No. G14',
type: 'ship-to',
address: {
street: '113-114, Central',
city: 'Hong Kong'
}
}
],
contents: [
{
product: 'gs1:01:00001254563898',
quantity: 250
},
{
product: 'gs1:01:00283679123844',
quantity: 42
}
],
tags: [
'ongoing',
'important',
'access-all'
]
};
operator.shipmentNotice().create(payload)
.then(console.log);
```
***
## Read all shipment notices
Read all shipment notices in an account.
```javascript
operator.shipmentNotice().read()
.then(console.log);
```
***
## Read a shipment notice
Read a shipment notice resource.
```javascript
const shipmentNoticeId = 'UnghCKffVg8a9KwRwE5C9qBs';
operator.shipmentNotice(shipmentNoticeId).read()
.then(console.log);
```
***
## Update a shipment notice
Update a shipment notice resource.
Replacement Operation
Updating a shipment notice with a `PUT` request is a replacement operation - the whole new version of the shipment notice must be provided.
```javascript
const shipmentNoticeId = 'UnghCKffVg8a9KwRwE5C9qBs';
const payload = {
asnId: '9827429837429823828273',
version: '2',
purchaseOrderId: '4700990774',
issueDate: '2019-06-19T16:39:57-08:00',
transportation: 'Expedited Freight',
parties: [
{
id: 'gs1:414:01251',
type: 'ship-from'
},
{
name: 'The Landmark, Shop No. G14',
type: 'ship-to',
address: {
street: '113-114, Central',
city: 'Hong Kong'
}
}
],
tags: [
'ongoing',
'important',
'access-all'
]
};
operator.shipmentNotice(shipmentNoticeId).update(payload)
.then(console.log);
```
***
## Delete a shipment notice
Delete a shipment notice resource.
```javascript
const shipmentNoticeId = 'UnghCKffVg8a9KwRwE5C9qBs';
operator.shipmentNotice(shipmentNoticeId).delete();
```
***