DeliveryCloudAPI

## Sections
• [Getting started with DeliveryCloud API](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/api-refrence.md): The DeliveryCloud API enables uploading shipments from external sources to the nShift portal. We accept shipments from all carriers listed in our central carrier library, supporting a comprehensive range of services and additional options. Each shipment is uploaded individually, shipment - and or tracking numbers must be included in each transaction. The API also provides a metadata list of supported carriers, services, and add-ons, with an option to define a custom carrier. Our OpenAPI documentation can be found here https://api.nshiftportal.com/delivery-cloud/swagger/index.html Important: Users of the DeliveryCloud API are responsible for selecting the correct carrier and ensuring that shipment and tracking numbers are valid and properly formatted to enable nShift to deliver accurate carrier tracking. 1 Access nShiftportal Access the nShift Portal 2 Create a DeliveryCloud organization Create an organization that reflect your business. 3 Copy your organization ids Note down your organization and memberaccount ids. 4 Use your organization details in the API Once the organization is configured, the DeliveryCloud API can be used to upload shipments. Authentication To integrate with the DeliveryCloud API, you will need an nShift portal user account with an API client id and secret. More detail under authentication section and in our helpcenter article Authorization To be authorized to use the DeliveryCloud API, you need to set the ShipmentDataAPI scope when creating the client. Rate limiting Clients exceeding 700 requests per minute will be throttled, receiving an HTTP status code 429 in the response.
  • [Authentication](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/api-refrence/authentication.md): nShift DeliveryCloud API is implemented with Oauth2 and the standard client credentials grant type. A registred client is required, to perform the login. Request an access token Use HTTP POST Production server: https://account.nshiftportal.com/idp/connect/token Test server: https://account.qa.nshiftportal.dev/idp/connect/token Request Header application/x-www-form-urlencoded Request Body grant_type: client_credentials client_id: your client id client_secret: your secret
• [Carriers](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/carriers.md): The carriers endpoints are used to retrieve and list available carriers, services, and add-ons for use with the DeliveryCloud API. To find which carriers we support, start here: https://nshift.com/carrier-library#search-library . For assistance identifying the carriers listed in the carrier endpoint, please contact our customer service team. API users are responsible for selecting the correct carrier. Creating a custom carrier structure means opting out of nShift-provided tracking data. Tracking information will need to be supplied through a custom connection.
  • [/metadata/carriers](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/carriers/metadata-carriers.md): The /metadata/carriers section lists information about available carriers
  • [/metadata/carriers/{carrierId}/services](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/carriers/metadata-carriers-carrierid-services.md): The /metadata/carriers/{carrierId}/services lists available services for a specific carrier.
  • [/metadata/carriers/{carrierId}/addons](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/carriers/metadata-carriers-carrierid-addons.md): The /metadata/carriers/{carrierId}/addons lists available addons for a specific carrier.
  • [/metadata/carriers](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/carriers/metadata-carriers-1.md): The /metadata/carriers section creates a customer specific carrier, including services, and add-ons associated with each carrier.
• [Shipments](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/shipments.md): The shipment and events endpoints are used to upload shipments and events to the DeliveryCloud organization. Prerequisite information includes the organization member account ID under which the shipment will be created, as well as the carrier and service ID to associated with the shipment. Notice an event of type book & print is mandatory on the shipment to reflect when it was created or booked in orginiating source system Useful information By default the Unit of measure (UoM) in the API is meter (m)and kilogram (kg). Addtional fields are available as attributes , which are sent as key value pairs. See seprate page. For PUDO shipment Party type 10 needs to be included. CustomerNo represent the carrier pudo id. This article explain the normalized statuses we work with
  • [/Shipments](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/shipments/v2-shipments.md): The Shipments endpoint creates shipments in the DeliveryCloud.
    • [Attributes](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/shipments/v2-shipments/attributes.md): The attributes can provide addtional field and use cases Field name Type id Example ProjectName 5 ProjectName Receiver account at sender 6 123456 Wanted delivery time 9 2025-01-01-T23:59:59 The required delivery time 10 2025-01-01-T23:59:59 Receiver account at carrier 11 123456 Sender reference 12 Sender refrence Booking reference 16 Booking reference Attention text 27 Attention text Custom field1 63 any value Custom field2 64 any value Custom field3 65 any value Custom field4 66 any value Custom field5 67 any value Custom field6 68 any value Custom field7 69 any value Custom field8 70 any value Custom field9 71 any value Custom field10 72 any value DeliveryStartDatetime 110 2025-01-01-T23:59:59 DeliveryEndDatetime 111 2025-01-01-T23:59:59 AdditionalReceiverReference 128 Additional receiver reference TrackingUrl 147 www.tracking.com/123456 PortalBarcode1 279 123456 PortalBarcode2 280 123456 CustomerPromiseDate 308 2025-01-01-T23:59:59 PickupCode 327 123456 QRCodeLink 340 www.tracking.com/123456
  • [/Events](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/shipments/v2-events.md): The Events endpoint adds book & print events on shipments in the DeliveryCloud. For tracking events use ShipmentDataAPI
  • [/Shipments/{shipmentUuid}](https://app.theneo.io/nshiftone/deliverycloudapi/deliverycloud/shipments/v2-shipments-shipmentuuid.md): The /Shipments/{shipmentUuid} allows users to query shipments. For more advances querys use the ShipmentDataAPI