SHshipium
label-generation

Set the partner manifest id and timestamp for any (matching) labels that meet the supplied criteria, are eligible for manifesting, and have not been manifested.

Changed on
put/api/v1/deliveryexperience/shipment/carrierSelection/labels/endOfDayManifest

Request

Request body

carrierIdstring required

The carrier that should have their labels go through the end-of-day process.

originCountrystring required

The ISO 3166-1 alpha-2 country code of the origin for any labels that should go through the end-of-day process.

originPostalstring required

The postal code of the origin for any labels that should go through the end-of-day process.

partnerManifestIdstring required

The identifier used by the partner to associate these labels.

fromDateTimestring date-time

Any labels with a manifestDateTime after this ISO-8601 date-time will go through the end-of-day process (if they have not already been through this process). If this is not provided, all labels that meet the other criteria, and have not already been through the end-of-day process, will be updated.

toDateTimestring date-time

Any labels with a manifestDateTime prior to this ISO-8601 date-time will go through the end-of-day process (if they have not already been through this process). If this is not provided, all labels that meet the other criteria, and have not already been through the end-of-day process, will be updated.

Response

The number of labels that were manifested

matchedinteger required

The number of records that matched the filter to be updated.

updatedinteger required

The number of records that were actually updated.

Example response

{
  "matched": 1234,
  "updated": 1111
}

Changes