> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/fulfillment-or-parcels.md).

# Fulfillment | Parcels

## List outbound parcels for order fulfillment

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

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Fulfillment | Parcels"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."},"ParcelSortParameter":{"enum":["created","status"],"type":"string","description":"Parameters according to which a customer can be sorted."},"SortOrder":{"enum":["asc","desc"],"type":"string","description":"Order in which the result of a list request is sorted."},"ParcelList":{"required":["items","self","total"],"type":"object","properties":{"previous":{"$ref":"#/components/schemas/ResourceLink"},"next":{"$ref":"#/components/schemas/ResourceLink"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Parcel"},"description":"The list of result items."},"total":{"type":"integer","description":"The total number of items.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"Parcel":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the parcel.","format":"int32"},"createdBy":{"$ref":"#/components/schemas/UserReference"},"created":{"type":"string","description":"Date on which the parcel entry was created. (ISO 8601 format)","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"deliveryNoteNumber":{"type":"string","description":"Identification number of the delivery note in the parcel","nullable":true},"originAddress":{"$ref":"#/components/schemas/Address"},"recipientName":{"type":"string","description":"For example, the name of the person to whom the shipment was entrusted. Corresponds to Address Line 1 in package shipping at the carrier.","nullable":true},"referenceNumber":{"type":"string","description":"Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to.\nThis could be an order number or any other reference number agreed upon with the recipient.","nullable":true},"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/ParcelItem"},"description":"Items that are included in the parcel.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ParcelItem":{"type":"object","properties":{"serviceInstance":{"$ref":"#/components/schemas/ResourceReference_Int32"},"fulfillmentOrder":{"$ref":"#/components/schemas/ResourceReference_Int64"}},"additionalProperties":false},"ResourceReference_Int32":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceReference_Int64":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/fulfillment/parcels":{"get":{"tags":["Fulfillment | Parcels"],"summary":"List outbound parcels for order fulfillment","description":"Retrieve a list of parcels that were sent by your organization.","parameters":[{"name":"fulfillmentOrders","in":"query","description":"Filter for parcels which are related to those fulfillment orders.","schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"customers","in":"query","description":"Filter for parcels where these customers are the recipients.","schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"statuses","in":"query","description":"Filter the parcels by statuses.","schema":{"type":"array","items":{"$ref":"#/components/schemas/ParcelStatus"}}},{"name":"createdAfter","in":"query","description":"Filter the parcels created after the specified date.","schema":{"type":"string","format":"date-time"}},{"name":"sortBy","in":"query","description":"Sort the items by a given criterion.","schema":{"$ref":"#/components/schemas/ParcelSortParameter"}},{"name":"sortOrder","in":"query","description":"Sort the items in a given order (asc|desc).","schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"offset","in":"query","description":"Specifies the index of the first item to return","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"Specifies the maximum number of items to return (min: 1; max: 1000)","schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"OK: A list of parcels.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelList"}}}},"400":{"description":"Bad request: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied or resource does not exist anymore.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /v1/fulfillment/parcels

>

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Fulfillment | Parcels"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"ParcelCreateModel":{"required":["customerId","fulfillmentOrderIds","status"],"type":"object","properties":{"fulfillmentOrderIds":{"minItems":1,"type":"array","items":{"type":"integer","format":"int64"},"description":"Fulfillment items for which the parcel is created. Specify all fulfillment items whose service instances are sent with this package.\nAll fulfillment orders must belong to the same customer."},"customerId":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Id of the customer who receives the parcel.","format":"int32"},"deliveryAddressId":{"type":"integer","description":"Address where the parcel is delivered to. The address needs to belong to the recipient company/customer.","format":"int32","nullable":true},"originAddressId":{"type":"integer","description":"Address from which the parcel is sent. The address needs to belong to the sender company (your customer entity).","format":"int32","nullable":true},"recipientName":{"maxLength":100,"minLength":0,"type":"string","description":"The name of the recipient in addition to the delivery address.\nCorresponds to Address Line 1 in shipping information of the carrier.\nFor example, the name of the person to whom the shipment was entrusted.","nullable":true},"referenceNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to.\nThis could be an order number or any other reference number agreed upon with the recipient.","nullable":true},"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryNoteNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Identification number of the delivery note in the parcel.","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true}},"additionalProperties":false},"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."},"Parcel":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the parcel.","format":"int32"},"createdBy":{"$ref":"#/components/schemas/UserReference"},"created":{"type":"string","description":"Date on which the parcel entry was created. (ISO 8601 format)","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"deliveryNoteNumber":{"type":"string","description":"Identification number of the delivery note in the parcel","nullable":true},"originAddress":{"$ref":"#/components/schemas/Address"},"recipientName":{"type":"string","description":"For example, the name of the person to whom the shipment was entrusted. Corresponds to Address Line 1 in package shipping at the carrier.","nullable":true},"referenceNumber":{"type":"string","description":"Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to.\nThis could be an order number or any other reference number agreed upon with the recipient.","nullable":true},"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/ParcelItem"},"description":"Items that are included in the parcel.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ParcelItem":{"type":"object","properties":{"serviceInstance":{"$ref":"#/components/schemas/ResourceReference_Int32"},"fulfillmentOrder":{"$ref":"#/components/schemas/ResourceReference_Int64"}},"additionalProperties":false},"ResourceReference_Int32":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceReference_Int64":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/fulfillment/parcels":{"post":{"tags":["Fulfillment | Parcels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelCreateModel"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parcel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get a single parcel by id

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

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Fulfillment | Parcels"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"Parcel":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the parcel.","format":"int32"},"createdBy":{"$ref":"#/components/schemas/UserReference"},"created":{"type":"string","description":"Date on which the parcel entry was created. (ISO 8601 format)","format":"date-time"},"customer":{"$ref":"#/components/schemas/CustomerReference"},"deliveryAddress":{"$ref":"#/components/schemas/Address"},"deliveryNoteNumber":{"type":"string","description":"Identification number of the delivery note in the parcel","nullable":true},"originAddress":{"$ref":"#/components/schemas/Address"},"recipientName":{"type":"string","description":"For example, the name of the person to whom the shipment was entrusted. Corresponds to Address Line 1 in package shipping at the carrier.","nullable":true},"referenceNumber":{"type":"string","description":"Carriers often allow adding a reference number to a parcel, helping the recipient to identify what the parcel is related to.\nThis could be an order number or any other reference number agreed upon with the recipient.","nullable":true},"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/ParcelItem"},"description":"Items that are included in the parcel.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"UserReference":{"required":["self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the employee.","format":"int32"},"firstName":{"type":"string","description":"The first/given name of the employee.","nullable":true},"lastName":{"type":"string","description":"The last/family name of the employee.","nullable":true},"email":{"type":"string","description":"The contact and login mail address.","nullable":true},"username":{"type":"string","description":"The username to log in to the app. The value has to be an e-mail address.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceLink":{"required":["href"],"type":"object","properties":{"href":{"minLength":1,"type":"string","description":"The target resource URI."},"method":{"type":"string","description":"The HTTP method to use for the request.","nullable":true}},"additionalProperties":false},"CustomerReference":{"required":["id","name","self"],"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the customer.","format":"int32"},"name":{"minLength":1,"type":"string","description":"The name of the customer."},"customerNumber":{"type":"string","description":"Optional identifier of the customer defined by the supplier.","nullable":true},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"Address":{"required":["id","self"],"type":"object","properties":{"line1":{"maxLength":100,"minLength":0,"type":"string","description":"First line of the address. e.g. company name or P.O. box.","nullable":true},"street":{"maxLength":100,"minLength":0,"type":"string","description":"The street name of the address.","nullable":true},"number":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric house number in the street.","nullable":true},"addition":{"maxLength":1500,"minLength":0,"type":"string","description":"Addition to the address (line 3) to provide further information for delivery.","nullable":true},"city":{"maxLength":100,"minLength":0,"type":"string","description":"The city name of the address.","nullable":true},"postalCode":{"maxLength":30,"minLength":0,"type":"string","description":"The alphanumeric postal code or zip of the address.","nullable":true},"countryCode":{"maxLength":2,"minLength":0,"type":"string","description":"ISO-3166-1 code of the country.","nullable":true},"regionCode":{"maxLength":10,"minLength":0,"type":"string","description":"ISO-3166-2 code of the region / administrative area. Required e.g. in USA, Canada, Australia or Italy.","nullable":true},"regionName":{"maxLength":100,"minLength":0,"type":"string","description":"Name of the region / administrative area (if no ISO code is given/existing).","nullable":true},"dependentLocality":{"maxLength":200,"minLength":0,"type":"string","description":"A dependent locality is an address element that distinguishes a premise when an address thoroughfare appears more than once in the same post town. PAF holds details of approximately 30,000 localities within the UK.","nullable":true},"phoneNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Phone number of the address. Used primarily for delivery purposes.","nullable":true},"id":{"type":"integer","description":"The id to identify the address in the system.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false,"description":"Postal address for the shipment of goods or invoices."},"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."},"ParcelItem":{"type":"object","properties":{"serviceInstance":{"$ref":"#/components/schemas/ResourceReference_Int32"},"fulfillmentOrder":{"$ref":"#/components/schemas/ResourceReference_Int64"}},"additionalProperties":false},"ResourceReference_Int32":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int32"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ResourceReference_Int64":{"required":["id","self"],"type":"object","properties":{"id":{"type":"integer","description":"The referenced resource.","format":"int64"},"self":{"$ref":"#/components/schemas/ResourceLink"}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/fulfillment/parcels/{parcelId}":{"get":{"tags":["Fulfillment | Parcels"],"summary":"Get a single parcel by id","description":"Single parcel object with enhanced information regarding addresses and related fulfillment orders.","parameters":[{"name":"parcelId","in":"path","description":"Id of the parcel to be returned.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK: A single parcel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Parcel"}}}},"400":{"description":"Bad request: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied or resource does not exist anymore.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Update an existing parcel

> Update an existing parcel regarding tracking information and status.

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Fulfillment | Parcels"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"ParcelUpdateModel":{"required":["status"],"type":"object","properties":{"carrier":{"type":"string","description":"Transport carrier of the parcel. Allowed values: DHL, DPD, GLS, UPS, Hermes, Fedex, trans-o-flex, Other, Partner","nullable":true},"status":{"$ref":"#/components/schemas/ParcelStatus"},"expectedDeliveryDate":{"type":"string","description":"UTC date on which the parcel is expected to arrive at the recipient. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryDate":{"type":"string","description":"UTC date on which the parcel has arrived at the recipient. Should only be set when the delivery is completed. (ISO 8601 format)","format":"date-time","nullable":true},"deliveryNoteNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Identification number of the delivery note in the parcel.","nullable":true},"note":{"maxLength":500,"minLength":0,"type":"string","description":"Note field to add further information regarding the parcel.","nullable":true},"trackingNumber":{"maxLength":50,"minLength":0,"type":"string","description":"Tracking number of the parcel provided by the carrier.","nullable":true},"trackingLink":{"maxLength":2000,"minLength":0,"type":"string","description":"Tracking link of the parcel provided by the carrier to allow the customer to get details regarding their delivery.","nullable":true},"externalId":{"maxLength":50,"minLength":0,"type":"string","description":"Id of the parcel in an external system. Can be used to refer to the parcel in your own shipping system.","nullable":true}},"additionalProperties":false},"ParcelStatus":{"enum":["unknown","new","ready","in-transit","delayed","delivered","picked-up","failed","refused-by-recipient","returned-to-sender","cancelled"],"type":"string","description":"Status of a parcel."},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/fulfillment/parcels/{parcelId}":{"put":{"tags":["Fulfillment | Parcels"],"summary":"Update an existing parcel","description":"Update an existing parcel regarding tracking information and status.","parameters":[{"name":"parcelId","in":"path","description":"The identifier of the parcel to be updated.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The data to update the parcel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParcelUpdateModel"}}}},"responses":{"204":{"description":"NoContent: Parcel successfully updated"},"400":{"description":"Bad request: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied or resource does not exist anymore.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Delete a parcel

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

```json
{"openapi":"3.0.4","info":{"title":"Equipme Customer API","version":"v1"},"tags":[{"name":"Fulfillment | Parcels"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.","name":"X-API-KEY","in":"header"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string","nullable":true},"errorDescription":{"type":"string","nullable":true},"data":{"nullable":true}},"additionalProperties":false}}},"paths":{"/v1/fulfillment/parcels/{parcelId}":{"delete":{"tags":["Fulfillment | Parcels"],"summary":"Delete a parcel","description":"Fully deletes the parcel with its information. Note: there is no historication of this.","parameters":[{"name":"parcelId","in":"path","description":"The identifier of the parcel to be deleted.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"NoContent: Parcel successfully deleted"},"400":{"description":"Bad request: See response message for details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized: Invalid api key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden: Resource access denied or resource does not exist anymore.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://hub.equipme.io/development/api-reference-app/fulfillment-or-parcels.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.