Fulfillment | Parcels

List outbound parcels for order fulfillment

get

Retrieve a list of parcels that were sent by your organization.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Query parameters

fulfillmentOrdersinteger · int64[]Optional

Filter for parcels which are related to those fulfillment orders.

customersinteger · int32[]Optional

Filter for parcels where these customers are the recipients.

createdAfterstring · date-timeOptional

Filter the parcels created after the specified date.

sortBystring · enumOptional

Parameters according to which a customer can be sorted.

Possible values:

sortOrderstring · enumOptional

Order in which the result of a list request is sorted.

Possible values:

offsetinteger · int32Optional

Specifies the index of the first item to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000)

Default: 100

Responses

200

OK: A list of parcels.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

get/v1/fulfillment/parcels

GET /v1/fulfillment/parcels HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "id": 4,
      "createdBy": {
        "id": 4,
        "firstName": "Pierce",
        "lastName": "Bell",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "created": "2021-09-20T00:00:00Z",
      "customer": {
        "id": 4,
        "name": "foo Inc.",
        "customerNumber": "C00001",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "deliveryAddress": {
        "line1": "equipme GmbH",
        "street": "W 55th St",
        "number": 240,
        "addition": "3rd floor",
        "city": "New York",
        "postalCode": 10019,
        "countryCode": "US",
        "regionCode": "NY",
        "regionName": "New York",
        "dependentLocality": "Chilmington Green",
        "phoneNumber": "+1 212-555-1234",
        "id": 83,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "deliveryNoteNumber": "text",
      "originAddress": {
        "line1": "equipme GmbH",
        "street": "W 55th St",
        "number": 240,
        "addition": "3rd floor",
        "city": "New York",
        "postalCode": 10019,
        "countryCode": "US",
        "regionCode": "NY",
        "regionName": "New York",
        "dependentLocality": "Chilmington Green",
        "phoneNumber": "+1 212-555-1234",
        "id": 83,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "recipientName": "John Doe",
      "referenceNumber": "Order 98765",
      "carrier": "UPS",
      "status": "unknown",
      "expectedDeliveryDate": "2024-03-18T12:00:00Z",
      "deliveryDate": "2021-09-20T12:00:00Z",
      "note": "Parcel is fragile",
      "trackingNumber": "1Z62369V6825030742",
      "trackingLink": "https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails",
      "externalId": "P123456",
      "items": [
        {
          "serviceInstance": {
            "id": 1,
            "self": {
              "href": "text",
              "method": "text"
            }
          },
          "fulfillmentOrder": {
            "id": 1,
            "self": {
              "href": "text",
              "method": "text"
            }
          }
        }
      ],
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

post

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Body

fulfillmentOrderIdsinteger · int64[] · min: 1Required

Fulfillment items for which the parcel is created. Specify all fulfillment items whose service instances are sent with this package. All fulfillment orders must belong to the same customer.

customerIdinteger · int32 · min: 1 · max: 2147483647Required

Id of the customer who receives the parcel.

Example: 42

deliveryAddressIdinteger · int32 · nullableOptional

Address where the parcel is delivered to. The address needs to belong to the recipient company/customer.

Example: 815

originAddressIdinteger · int32 · nullableOptional

Address from which the parcel is sent. The address needs to belong to the sender company (your customer entity).

Example: 4218

recipientNamestring · max: 100 · nullableOptional

The name of the recipient in addition to the delivery address. Corresponds to Address Line 1 in shipping information of the carrier. For example, the name of the person to whom the shipment was entrusted.

Example: John Doe

referenceNumberstring · max: 50 · nullableOptional

Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to. This could be an order number or any other reference number agreed upon with the recipient.

Example: Order 98765

carrierstring · nullableOptional

Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner

Example: UPS

statusstring · enumRequired

Status of a parcel.

Possible values:

expectedDeliveryDatestring · date-time · nullableOptional

UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)

Example: 2024-03-18T00:00:00Z

deliveryDatestring · date-time · nullableOptional

UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)

Example: 2021-09-20T00:00:00Z

deliveryNoteNumberstring · max: 50 · nullableOptional

Identification number of the delivery note in the parcel.

notestring · max: 500 · nullableOptional

Note field to add further information regarding the parcel.

Example: Parcel is fragile

trackingNumberstring · max: 50 · nullableOptional

Tracking number of the parcel provided by the carrier.

Example: 1Z62369V6825030742

trackingLinkstring · max: 2000 · nullableOptional

Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.

Example: https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails

externalIdstring · max: 50 · nullableOptional

Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.

Example: P123456

Responses

201

Created

application/json

idinteger · int32Required

The identifier of the parcel.

Example: 4

createdstring · date-timeOptional

Date on which the parcel entry was created. (ISO 8601 format)

Example: 2021-09-20T00:00:00Z

deliveryNoteNumberstring · nullableOptional

Identification number of the delivery note in the parcel

recipientNamestring · nullableOptional

For example, the name of the person to whom the shipment was entrusted. Corresponds to Address Line 1 in package shipping at the carrier.

Example: John Doe

referenceNumberstring · nullableOptional

Example: Order 98765

carrierstring · nullableOptional

Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner

Example: UPS

statusstring · enumOptional

Status of a parcel.

Possible values:

expectedDeliveryDatestring · date-time · nullableOptional

UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)

Example: 2024-03-18T12:00:00Z

deliveryDatestring · date-time · nullableOptional

UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)

Example: 2021-09-20T12:00:00Z

notestring · max: 500 · nullableOptional

Note field to add further information regarding the parcel.

Example: Parcel is fragile

trackingNumberstring · max: 50 · nullableOptional

Tracking number of the parcel provided by the carrier.

Example: 1Z62369V6825030742

trackingLinkstring · max: 2000 · nullableOptional

Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.

Example: https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails

externalIdstring · max: 50 · nullableOptional

Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.

Example: P123456

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post/v1/fulfillment/parcels

POST /v1/fulfillment/parcels HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 498

{
  "fulfillmentOrderIds": [
    1
  ],
  "customerId": 42,
  "deliveryAddressId": 815,
  "originAddressId": 4218,
  "recipientName": "John Doe",
  "referenceNumber": "Order 98765",
  "carrier": "UPS",
  "status": "unknown",
  "expectedDeliveryDate": "2024-03-18T00:00:00Z",
  "deliveryDate": "2021-09-20T00:00:00Z",
  "deliveryNoteNumber": "text",
  "note": "Parcel is fragile",
  "trackingNumber": "1Z62369V6825030742",
  "trackingLink": "https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails",
  "externalId": "P123456"
}

{
  "id": 4,
  "createdBy": {
    "id": 4,
    "firstName": "Pierce",
    "lastName": "Bell",
    "email": "p.bell@foo.io",
    "username": "j.doe@foo.inc",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "created": "2021-09-20T00:00:00Z",
  "customer": {
    "id": 4,
    "name": "foo Inc.",
    "customerNumber": "C00001",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "deliveryAddress": {
    "line1": "equipme GmbH",
    "street": "W 55th St",
    "number": 240,
    "addition": "3rd floor",
    "city": "New York",
    "postalCode": 10019,
    "countryCode": "US",
    "regionCode": "NY",
    "regionName": "New York",
    "dependentLocality": "Chilmington Green",
    "phoneNumber": "+1 212-555-1234",
    "id": 83,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "deliveryNoteNumber": "text",
  "originAddress": {
    "line1": "equipme GmbH",
    "street": "W 55th St",
    "number": 240,
    "addition": "3rd floor",
    "city": "New York",
    "postalCode": 10019,
    "countryCode": "US",
    "regionCode": "NY",
    "regionName": "New York",
    "dependentLocality": "Chilmington Green",
    "phoneNumber": "+1 212-555-1234",
    "id": 83,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "recipientName": "John Doe",
  "referenceNumber": "Order 98765",
  "carrier": "UPS",
  "status": "unknown",
  "expectedDeliveryDate": "2024-03-18T12:00:00Z",
  "deliveryDate": "2021-09-20T12:00:00Z",
  "note": "Parcel is fragile",
  "trackingNumber": "1Z62369V6825030742",
  "trackingLink": "https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails",
  "externalId": "P123456",
  "items": [
    {
      "serviceInstance": {
        "id": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "fulfillmentOrder": {
        "id": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      }
    }
  ],
  "self": {
    "href": "text",
    "method": "text"
  }
}

Get a single parcel by id

get

Single parcel object with enhanced information regarding addresses and related fulfillment orders.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

parcelIdinteger · int32Required

Id of the parcel to be returned.

Responses

200

OK: A single parcel.

application/json

idinteger · int32Required

The identifier of the parcel.

Example: 4

createdstring · date-timeOptional

Date on which the parcel entry was created. (ISO 8601 format)

Example: 2021-09-20T00:00:00Z

deliveryNoteNumberstring · nullableOptional

Identification number of the delivery note in the parcel

recipientNamestring · nullableOptional

For example, the name of the person to whom the shipment was entrusted. Corresponds to Address Line 1 in package shipping at the carrier.

Example: John Doe

referenceNumberstring · nullableOptional

Example: Order 98765

carrierstring · nullableOptional

Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner

Example: UPS

statusstring · enumOptional

Status of a parcel.

Possible values:

expectedDeliveryDatestring · date-time · nullableOptional

UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)

Example: 2024-03-18T12:00:00Z

deliveryDatestring · date-time · nullableOptional

UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)

Example: 2021-09-20T12:00:00Z

notestring · max: 500 · nullableOptional

Note field to add further information regarding the parcel.

Example: Parcel is fragile

trackingNumberstring · max: 50 · nullableOptional

Tracking number of the parcel provided by the carrier.

Example: 1Z62369V6825030742

trackingLinkstring · max: 2000 · nullableOptional

Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.

Example: https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails

externalIdstring · max: 50 · nullableOptional

Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.

Example: P123456

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

get/v1/fulfillment/parcels/{parcelId}

GET /v1/fulfillment/parcels/{parcelId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": 4,
  "createdBy": {
    "id": 4,
    "firstName": "Pierce",
    "lastName": "Bell",
    "email": "p.bell@foo.io",
    "username": "j.doe@foo.inc",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "created": "2021-09-20T00:00:00Z",
  "customer": {
    "id": 4,
    "name": "foo Inc.",
    "customerNumber": "C00001",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "deliveryAddress": {
    "line1": "equipme GmbH",
    "street": "W 55th St",
    "number": 240,
    "addition": "3rd floor",
    "city": "New York",
    "postalCode": 10019,
    "countryCode": "US",
    "regionCode": "NY",
    "regionName": "New York",
    "dependentLocality": "Chilmington Green",
    "phoneNumber": "+1 212-555-1234",
    "id": 83,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "deliveryNoteNumber": "text",
  "originAddress": {
    "line1": "equipme GmbH",
    "street": "W 55th St",
    "number": 240,
    "addition": "3rd floor",
    "city": "New York",
    "postalCode": 10019,
    "countryCode": "US",
    "regionCode": "NY",
    "regionName": "New York",
    "dependentLocality": "Chilmington Green",
    "phoneNumber": "+1 212-555-1234",
    "id": 83,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "recipientName": "John Doe",
  "referenceNumber": "Order 98765",
  "carrier": "UPS",
  "status": "unknown",
  "expectedDeliveryDate": "2024-03-18T12:00:00Z",
  "deliveryDate": "2021-09-20T12:00:00Z",
  "note": "Parcel is fragile",
  "trackingNumber": "1Z62369V6825030742",
  "trackingLink": "https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails",
  "externalId": "P123456",
  "items": [
    {
      "serviceInstance": {
        "id": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "fulfillmentOrder": {
        "id": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      }
    }
  ],
  "self": {
    "href": "text",
    "method": "text"
  }
}

Update an existing parcel

put

Update an existing parcel regarding tracking information and status.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

parcelIdinteger · int32Required

The identifier of the parcel to be updated.

Body

carrierstring · nullableOptional

Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner

Example: UPS

statusstring · enumRequired

Status of a parcel.

Possible values:

expectedDeliveryDatestring · date-time · nullableOptional

UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)

Example: 2024-03-18T00:00:00Z

deliveryDatestring · date-time · nullableOptional

UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)

Example: 2021-09-20T00:00:00Z

deliveryNoteNumberstring · max: 50 · nullableOptional

Identification number of the delivery note in the parcel.

notestring · max: 500 · nullableOptional

Note field to add further information regarding the parcel.

Example: Parcel is fragile

trackingNumberstring · max: 50 · nullableOptional

Tracking number of the parcel provided by the carrier.

Example: 1Z62369V6825030742

trackingLinkstring · max: 2000 · nullableOptional

Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.

Example: https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails

externalIdstring · max: 50 · nullableOptional

Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.

Example: P123456

Responses

204

NoContent: Parcel successfully updated

No content

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

put/v1/fulfillment/parcels/{parcelId}

PUT /v1/fulfillment/parcels/{parcelId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "carrier": "UPS",
  "status": "unknown",
  "expectedDeliveryDate": "2024-03-18T00:00:00Z",
  "deliveryDate": "2021-09-20T00:00:00Z",
  "deliveryNoteNumber": "text",
  "note": "Parcel is fragile",
  "trackingNumber": "1Z62369V6825030742",
  "trackingLink": "https://ups.com/track?loc=en_GB&track=yes&trackNums=1Z62369V6825030742&requester=ST/trackdetails",
  "externalId": "P123456"
}

No content

Delete a parcel

delete

Fully deletes the parcel with its information. Note: there is no historication of this.

Authorizations

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

parcelIdinteger · int32Required

The identifier of the parcel to be deleted.

Responses

204

NoContent: Parcel successfully deleted

No content

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

delete/v1/fulfillment/parcels/{parcelId}

DELETE /v1/fulfillment/parcels/{parcelId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Last updated 1 hour ago

Was this helpful?