nshiftone

DeliveryCloud

Getting started

Carriers

Shipments

Default

DeliveryCloudAPI

Production

<p class="slate-p " >The Delivery Cloud API uploads shipments from external sources to nShift Portal. It accepts shipments for any carrier in the nShift <a href="https://nshift.com/carrier-library#search-library" target="_blank">carrier library</a>, with their services and add-ons.</p><p class="slate-p " >Each shipment needs a shipment number, a tracking number, or both.</p><p class="slate-p " >The API also lists supported carriers, services, and add-ons, and lets you define a custom carrier.</p><p class="slate-p " >The OpenAPI specification is also available in <a href="https://api.nshiftportal.com/delivery-cloud/swagger/index.html" target="_blank">Swagger</a>.</p><p class="slate-p " ></p><div style="width:100%;min-width:100%" class="callout-widget" data-type=info><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><strong class="slate-bold">Important:</strong> You&apos;re responsible for choosing the correct carrier and sending valid, correctly formatted shipment and tracking numbers. nShift needs these to provide accurate carrier tracking.</p></div></div><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Open nShift Portal</h3><p class="slate-p " >Go to Delivery Cloud settings in <a href="https://www.nshiftportal.com/ui/settings/delivery-cloud-org" target="_blank"><strong class="slate-bold">nShift Portal</strong></a>.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Create a Delivery Cloud organization</h3><p class="slate-p " >Create an organization that reflects your business.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Copy your organization IDs</h3><p class="slate-p " >Note the organization ID and member account ID.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >4</h6><h3 class="slate-h3 " >Use the IDs in your requests</h3><p class="slate-p " >Send the member account ID as <code class="slate-code">accountId</code> on each shipment, and the organization ID as <code class="slate-code">organizationId</code> when you list carriers.</p></div></div></div><p class="slate-p " ></p><div class="card-box" style="width:60%;"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" class="icon-style" xmlns="http://www.w3.org/2000/svg"> <g clipPath="url(#clip0_2631_4976)"> <path d="M7.50505 23.9996C5.6948 23.9984 3.94606 23.3426 2.58151 22.153C1.21696 20.9635 0.32869 19.3206 0.0806168 17.5274C-0.167457 15.7342 0.241405 13.9118 1.23176 12.3965C2.22211 10.8812 3.72711 9.77519 5.46905 9.28261C6.73518 8.92003 8.07535 8.90346 9.35005 9.23461L17.2581 1.32861C17.6779 0.90589 18.1774 0.570741 18.7278 0.342603C19.2781 0.114465 19.8683 -0.00212179 20.4641 -0.00039304C21.4016 0.000401392 22.3005 0.373198 22.9635 1.03615C23.6265 1.69911 23.9993 2.59805 24.0001 3.53561C24.0016 4.1314 23.885 4.72158 23.6571 5.27205C23.4291 5.82251 23.0944 6.32233 22.6721 6.74261L22.0001 7.41461C21.624 7.78805 21.116 7.99823 20.5861 7.99961H19.0001V8.99961C19.0001 9.53004 18.7893 10.0387 18.4143 10.4138C18.0392 10.7889 17.5305 10.9996 17.0001 10.9996H16.0001V12.5856C16.0008 12.8483 15.9493 13.1086 15.8487 13.3513C15.7482 13.594 15.6004 13.8144 15.4141 13.9996L14.7641 14.6496C15.097 15.9237 15.0808 17.264 14.7171 18.5296C14.3078 19.9716 13.4774 21.2586 12.3322 22.2258C11.187 23.193 9.77921 23.7964 8.28905 23.9586C8.02859 23.9857 7.76692 23.9994 7.50505 23.9996ZM7.50505 10.9996C6.4812 10.9986 5.4774 11.2834 4.60664 11.822C3.73588 12.3606 3.03274 13.1315 2.57636 14.048C2.11998 14.9645 1.92848 15.9902 2.02343 17.0096C2.11837 18.0291 2.49599 19.0018 3.11377 19.8182C3.73155 20.6347 4.56497 21.2625 5.52021 21.631C6.47545 21.9995 7.51458 22.0941 8.52064 21.904C9.5267 21.714 10.4597 21.2469 11.2147 20.5553C11.9697 19.8637 12.5167 18.9752 12.7941 17.9896C13.106 16.9061 13.0711 15.7522 12.6941 14.6896C12.6325 14.5121 12.6222 14.3209 12.6643 14.1379C12.7064 13.9549 12.7992 13.7874 12.9321 13.6546L14.0001 12.5856V10.9996C14.0001 10.4692 14.2108 9.96047 14.5858 9.58539C14.9609 9.21032 15.4696 8.99961 16.0001 8.99961H17.0001V7.99961C17.0001 7.46917 17.2108 6.96047 17.5858 6.58539C17.9609 6.21032 18.4696 5.99961 19.0001 5.99961H20.5861L21.2581 5.32761C21.494 5.09276 21.6811 4.81347 21.8084 4.50588C21.9358 4.1983 22.0009 3.86852 22.0001 3.53561C21.9998 3.12849 21.838 2.73811 21.5502 2.45014C21.2624 2.16217 20.8722 2.00014 20.4651 1.99961C20.1319 1.99879 19.8019 2.06403 19.4942 2.19157C19.1864 2.3191 18.907 2.50639 18.6721 2.74261L10.3411 11.0726C10.2081 11.2055 10.0404 11.2982 9.85714 11.3401C9.6739 11.382 9.48256 11.3715 9.30505 11.3096C8.72512 11.1054 8.11488 11.0006 7.50005 10.9996H7.50505ZM5.00005 17.9996C5.00005 18.1974 5.0587 18.3907 5.16858 18.5552C5.27847 18.7196 5.43464 18.8478 5.61737 18.9235C5.8001 18.9992 6.00116 19.019 6.19514 18.9804C6.38913 18.9418 6.56731 18.8466 6.70716 18.7067C6.84701 18.5669 6.94225 18.3887 6.98084 18.1947C7.01942 18.0007 6.99962 17.7997 6.92393 17.6169C6.84825 17.4342 6.72007 17.278 6.55562 17.1681C6.39117 17.0583 6.19783 16.9996 6.00005 16.9996C5.73484 16.9996 5.48048 17.105 5.29295 17.2925C5.10541 17.48 5.00005 17.7344 5.00005 17.9996Z" fill="#374957"/> </g> <defs> <clipPath id="clip0_2631_4976"> <rect width="24" height="24" fill="white"/> </clipPath> </defs> </svg><div ><h3 class="slate-h3 " >Authentication</h3><p class="slate-p " >You need an nShift Portal user with an API client ID and secret. See <a href="authentication" target="_self">Authentication</a> and <a href="https://helpcenter.nshift.com/hc/en-us/articles/360026218413-API-configuration-setup" target="_blank">API configuration setup</a>.</p></div></div><div class="card-box" style="width:60%;"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" class="icon-style" xmlns="http://www.w3.org/2000/svg"> <g clipPath="url(#clip0_2631_5255)"> <path d="M19 0H5C3.67441 0.00158786 2.40356 0.528882 1.46622 1.46622C0.528882 2.40356 0.00158786 3.67441 0 5L0 19C0.00158786 20.3256 0.528882 21.5964 1.46622 22.5338C2.40356 23.4711 3.67441 23.9984 5 24H19C20.3256 23.9984 21.5964 23.4711 22.5338 22.5338C23.4711 21.5964 23.9984 20.3256 24 19V5C23.9984 3.67441 23.4711 2.40356 22.5338 1.46622C21.5964 0.528882 20.3256 0.00158786 19 0V0ZM7 22V21C7 19.6739 7.52678 18.4021 8.46447 17.4645C9.40215 16.5268 10.6739 16 12 16C13.3261 16 14.5979 16.5268 15.5355 17.4645C16.4732 18.4021 17 19.6739 17 21V22H7ZM22 19C22 19.7956 21.6839 20.5587 21.1213 21.1213C20.5587 21.6839 19.7956 22 19 22V21C19 19.1435 18.2625 17.363 16.9497 16.0503C15.637 14.7375 13.8565 14 12 14C10.1435 14 8.36301 14.7375 7.05025 16.0503C5.7375 17.363 5 19.1435 5 21V22C4.20435 22 3.44129 21.6839 2.87868 21.1213C2.31607 20.5587 2 19.7956 2 19V5C2 4.20435 2.31607 3.44129 2.87868 2.87868C3.44129 2.31607 4.20435 2 5 2H19C19.7956 2 20.5587 2.31607 21.1213 2.87868C21.6839 3.44129 22 4.20435 22 5V19Z" fill="#374957"/> <path d="M12.0001 4.00031C11.209 4.00031 10.4356 4.2349 9.77781 4.67443C9.12002 5.11395 8.60733 5.73867 8.30458 6.46957C8.00182 7.20048 7.92261 8.00474 8.07695 8.78067C8.23129 9.55659 8.61226 10.2693 9.17167 10.8287C9.73108 11.3881 10.4438 11.7691 11.2197 11.9234C11.9957 12.0778 12.7999 11.9986 13.5308 11.6958C14.2617 11.3931 14.8864 10.8804 15.326 10.2226C15.7655 9.56479 16.0001 8.79143 16.0001 8.00031C16.0001 6.93944 15.5787 5.92202 14.8285 5.17188C14.0784 4.42173 13.061 4.00031 12.0001 4.00031ZM12.0001 10.0003C11.6045 10.0003 11.2179 9.88301 10.889 9.66324C10.5601 9.44348 10.3037 9.13112 10.1523 8.76567C10.001 8.40022 9.96135 7.99809 10.0385 7.61012C10.1157 7.22216 10.3062 6.8658 10.5859 6.58609C10.8656 6.30639 11.222 6.1159 11.6099 6.03873C11.9979 5.96156 12.4 6.00117 12.7655 6.15255C13.1309 6.30392 13.4433 6.56027 13.663 6.88916C13.8828 7.21806 14.0001 7.60474 14.0001 8.00031C14.0001 8.53074 13.7894 9.03945 13.4143 9.41452C13.0392 9.78959 12.5305 10.0003 12.0001 10.0003Z" fill="#374957"/> </g> <defs> <clipPath id="clip0_2631_5255"> <rect width="24" height="24" fill="white"/> </clipPath> </defs> </svg><div ><h3 class="slate-h3 " >Authorization</h3><p class="slate-p " >Create the API client with the <code class="slate-code">public_delivery_cloud_api</code> scope (Public Delivery Cloud Scope). Access tokens without this scope are rejected.</p></div></div><div class="card-box" style="width:60%;"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" class="icon-style" xmlns="http://www.w3.org/2000/svg"> <g clipPath="url(#clip0_2631_5104)"> <path d="M17 0C16.7348 0 16.4804 0.105357 16.2929 0.292893C16.1054 0.48043 16 0.734784 16 1C16 3.949 13.417 5 11 5H4C2.93913 5 1.92172 5.42143 1.17157 6.17157C0.421427 6.92172 0 7.93913 0 9L0 11C0.00218416 11.5987 0.139462 12.1893 0.401603 12.7276C0.663743 13.2659 1.04399 13.7381 1.514 14.109L5.086 22.081C5.34004 22.6521 5.75417 23.1373 6.27827 23.4779C6.80237 23.8185 7.41396 23.9998 8.039 24C8.53631 23.9997 9.02565 23.875 9.46247 23.6373C9.89929 23.3996 10.2697 23.0564 10.54 22.639C10.8104 22.2215 10.972 21.7431 11.0103 21.2473C11.0485 20.7515 10.9621 20.2539 10.759 19.8L8.559 15H11C13.417 15 16 16.051 16 19C16 19.2652 16.1054 19.5196 16.2929 19.7071C16.4804 19.8946 16.7348 20 17 20C17.2652 20 17.5196 19.8946 17.7071 19.7071C17.8946 19.5196 18 19.2652 18 19V1C18 0.734784 17.8946 0.48043 17.7071 0.292893C17.5196 0.105357 17.2652 0 17 0V0ZM8.937 20.619C9.00324 20.7686 9.03109 20.9323 9.01804 21.0954C9.005 21.2585 8.95145 21.4157 8.86227 21.5529C8.77309 21.69 8.65109 21.8027 8.50733 21.8808C8.36357 21.9589 8.20259 21.9999 8.039 22C7.8004 21.9998 7.56697 21.9304 7.36709 21.8001C7.1672 21.6698 7.00945 21.4842 6.913 21.266L4.105 15H6.359L8.937 20.619ZM16 14.6C14.5713 13.4992 12.8024 12.9331 11 13H4C3.46957 13 2.96086 12.7893 2.58579 12.4142C2.21071 12.0391 2 11.5304 2 11V9C2 8.46957 2.21071 7.96086 2.58579 7.58579C2.96086 7.21071 3.46957 7 4 7H11C12.8018 7.0683 14.5706 6.50403 16 5.405V14.6ZM23.9 15.452C23.8413 15.5696 23.7601 15.6744 23.6609 15.7606C23.5617 15.8467 23.4465 15.9125 23.3218 15.9541C23.1972 15.9957 23.0656 16.0123 22.9345 16.0031C22.8035 15.9938 22.6755 15.9588 22.558 15.9L20.558 14.9C20.3206 14.7814 20.1401 14.5735 20.0561 14.3218C19.972 14.0701 19.9915 13.7954 20.11 13.558C20.2286 13.3206 20.4365 13.1401 20.6882 13.0561C20.9399 12.972 21.2146 12.9914 21.452 13.11L23.452 14.11C23.6882 14.2285 23.8678 14.4356 23.9518 14.6861C24.0357 14.9366 24.0171 15.2102 23.9 15.447V15.452ZM20.11 6.452C20.0512 6.33448 20.0162 6.20653 20.0069 6.07546C19.9977 5.9444 20.0143 5.81279 20.0559 5.68816C20.0975 5.56353 20.1633 5.44832 20.2494 5.34912C20.3356 5.24991 20.4404 5.16866 20.558 5.11L22.558 4.11C22.7954 3.99145 23.0701 3.97205 23.3218 4.05606C23.5735 4.14008 23.7815 4.32063 23.9 4.558C24.0186 4.79537 24.038 5.07011 23.9539 5.32178C23.8699 5.57346 23.6894 5.78145 23.452 5.9L21.452 6.9C21.3345 6.95876 21.2065 6.99378 21.0755 7.00306C20.9444 7.01234 20.8128 6.99571 20.6882 6.9541C20.5635 6.9125 20.4483 6.84674 20.3491 6.76058C20.2499 6.67443 20.1687 6.56957 20.11 6.452ZM20 10C20 9.73478 20.1054 9.48043 20.2929 9.29289C20.4804 9.10536 20.7348 9 21 9H23C23.2652 9 23.5196 9.10536 23.7071 9.29289C23.8946 9.48043 24 9.73478 24 10C24 10.2652 23.8946 10.5196 23.7071 10.7071C23.5196 10.8946 23.2652 11 23 11H21C20.7348 11 20.4804 10.8946 20.2929 10.7071C20.1054 10.5196 20 10.2652 20 10Z" fill="#374957"/> </g> <defs> <clipPath id="clip0_2631_5104"> <rect width="24" height="24" fill="white"/> </clipPath> </defs> </svg><div ><h3 class="slate-h3 " >Rate limiting</h3><p class="slate-p " >Clients that exceed 700 requests per minute are throttled and receive <code class="slate-code">429 Too Many Requests</code>.</p></div></div><p class="slate-p " ></p>

The Delivery Cloud API uploads shipments from external sources to nShift Portal. It accepts shipments for any carrier in the nShift 

Each shipment needs a shipment number, a tracking number, or both.

The API also lists supported carriers, services, and add-ons, and lets you define a custom carrier.

The OpenAPI specification is also available in 

<p class="slate-p " >Use the Carrier endpoints to list the Carriers, Services, and add-ons you can use on shipments, and to define custom Carriers.</p><p class="slate-p " ></p><div style="width:100%;min-width:100%" class="callout-widget" data-type=info><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >To check which carriers nShift supports, search the <a href="https://nshift.com/carrier-library#search-library" target="_blank">carrier library</a>. For help identifying a carrier in the list, contact nShift Customer Support. You’re responsible for choosing the correct carrier.</p></div></div><p class="slate-p " ></p><div style="width:100%;min-width:100%" class="callout-widget" data-type=error><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.6989 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div ><p class="slate-p " >A custom Carrier doesn&apos;t get tracking data from nShift. Send tracking events for it through a custom connection.</p></div></div>

Use the Carrier endpoints to list the Carriers, Services, and add-ons you can use on shipments, and to define custom Carriers.

Basic shipment

Customs, prices, and dangerous goods

<p class="slate-p " >Use the Shipment and Event endpoints to upload shipments and their events to your Delivery Cloud organization.</p><p class="slate-p " >Before you start, you need the member account ID for the organization, and the carrier and service IDs for the shipment.</p><div style="width:100%;min-width:100%" class="callout-widget" data-type=info><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Every shipment needs a <code class="slate-code">BookAndPrint</code> event that records when it was created or booked in the source system.</p></div></div><h3 class="slate-h3 " >Useful information</h3><p class="slate-p " >• Units: Measurements use meters and kilograms.</p><p class="slate-p " >• Attributes: Send additional fields as key-value pairs in <code class="slate-code">attributes</code>. See <a href="attributes" target="_self">Attributes</a>.</p><p class="slate-p " >• Pickup points: For delivery to a pickup point, add a party with <code class="slate-code">type</code> <code class="slate-code">10</code> (<code class="slate-code">DropPoint</code>), and set <code class="slate-code">customerNo</code> to the carrier&apos;s pickup point ID.</p><p class="slate-p " >• Statuses: See <a href="https://helpcenter.nshift.com/hc/en-us/articles/8187489923100-Normalized-status-names" target="_blank">Normalized status names</a>.</p><div class="data-example-widget"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Use the Shipment and Event endpoints to upload shipments and their events to your Delivery Cloud organization.

Before you start, you need the member account ID for the organization, and the carrier and service IDs for the shipment.

• Units: Measurements use meters and kilograms.

• Attributes: Send additional fields as key-value pairs in 

• Pickup points: For delivery to a pickup point, add a party with 

<p class="slate-p " >Creates or updates Shipments. Provide an array of Shipments, each with <code class="slate-code">id</code>, <code class="slate-code">accountId</code>, <code class="slate-code">carrierId</code>, <code class="slate-code">serviceId</code>, and <code class="slate-code">type</code>. Returns confirmation (<code class="slate-code">202 Accepted</code>).</p><p class="slate-p " >Note: Each Shipment needs a <code class="slate-code">BookAndPrint</code> event that records when it was booked in the source system.</p>

Creates or updates Shipments. Provide an array of Shipments, each with 

 event that records when it was booked in the source system.

Create or update shipments

Bearer access token, as Bearer {access_token}. See Authentication

Authorization

A URI reference that identifies the problem type

type

title

status

An explanation specific to this occurrence of the problem

detail

A URI reference that identifies this occurrence of the problem

instance

<p class="slate-p " >Adds <code class="slate-code">BookAndPrint</code> events to a Shipment or Package. Provide <code class="slate-code">matchingInformation</code> and <code class="slate-code">events</code>. Returns confirmation (<code class="slate-code">202 Accepted</code>).</p><p class="slate-p " ></p><p class="slate-p " >Note: Send carrier tracking events through the Shipment Data API.</p>

 events to a Shipment or Package. Provide 

Note: Send carrier tracking events through the Shipment Data API.

Add events

Shipment or package the events belong to.

matchingInformation

events

<p class="slate-p " >Fetches a specific Shipment. Provide <code class="slate-code">shipmentUuid</code>. Returns the Shipment.</p><p class="slate-p " >Note: To search Shipments, use the Shipment Data API.</p>

Note: To search Shipments, use the Shipment Data API.

Get shipment

shipmentUuid

Identifies the Shipment. Generate a new UUID when you create it, and reuse it to update the Shipment.

Timestamp when the Shipment was created, in UTC

createdAt

Timestamp when the Shipment was last modified, in UTC

modifiedAt

Shipment number from the carrier, used for tracking.

**Remarks:**

*3 to 50 characters.*

number

A collection of maximum 3 additional identifiers for the shipment.

**Remarks:**

*Maximum 3 items. Each item is validated.*

additionalIdentifiers

Order numbers the Shipment fulfills.

**Remarks:**

*Maximum 50 characters each.*

orderNumbers

An extra reference provided by the carrier related to the shipment, in addition to the shipment number. Used in the Portal if needed for Return Data mappings. Also exposed as attribute type 279.

**Remarks:**

*Maximum 50 characters.*

barcode1

Another extra reference provided by the carrier related to the shipment, in addition to the shipment number. Used in the Portal if needed for Return Data mappings. Also exposed as attribute type 280.

**Remarks:**

*Maximum 50 characters.*

barcode2

The tracking URL on shipment level. Also exposed as attribute type 147.

**Remarks:**

*Maximum 1024 characters.*

trackingUrl

Language the carrier uses for notifications, tracking, and documents. One value per shipment. When absent, the receiver's country decides. Also available as attribute type 360.

**Remarks:**

*ISO 639-1 two-letter code, for example en. Stored in lowercase.*

languageCode

Business segmentation reference for the shipment. A single, product-agnostic value used to segment shipments per customer/business unit (e.g. for 3PL scenarios, filtering, reporting, and communication logic).

**Remarks:**

*Must not exceed 50 characters.*

segment

Shipment-level description of the goods. Line and article level descriptions take precedence when present.

**Remarks:**

*Maximum 128 characters.*

description

measurements

pickUpAtLocal

Window in which the carrier picks up the shipment from the sender, in local time.

pickupWindow

Date and time the Shipment was submitted (booked), in local time.

submitAtLocal

Delivery dates requested by the shipper at booking. Shipment level only: can't be set or updated through events. Replaces attribute types 9 and 10.

**Remarks:**

*Validated when provided.*

shipperDeliveryDates

The delivery date and time promised to the end customer, in local time (merchant delivery promise, e.g. produced by nShift/CPC at checkout). Replaces attribute type 308 (customer promise date). Updatable via events; the shipment field is the authoritative read surface.

**Remarks:**

*Format: ISO 8601 yyyy-MM-ddTHH:mm:ss.fffffffK. A time component of 00:00:00+00:00 corresponds to a date-only value: the shipper sent only a calendar date, and the value must be read as that date, never converted to another time zone.*

promisedDeliveryAtLocal

Delivery window estimated by the carrier, in local time.

**Remarks:**

*Takes precedence over estimatedTimeOfArrival when both are sent.*

carrierEstimatedDeliveryWindow

Delivery window estimated by nShift, in local time.

internalPlatformEstimatedDeliveryWindow

Identifies the member account that owns the Shipment.

accountId

Identifies the Carrier. Get it from List carriers.

carrierId

Identifies the carrier Service. Get it from List carrier services.

serviceId

The added services.

**Remarks:**

*Each UUID must be non-empty. At ingestion every id is validated against the add-on configuration in Metadata: an id with no matching add-on is rejected, and an add-on that is configured for a specific carrier is rejected when it does not belong to the shipment's carrierId. Because the configuration is environment-specific, the same id can be accepted in one environment and rejected in another.*

addOns

The shipment type.

**Remarks:**

*Cannot be Unknown.*

0 - Unknown
1 - Regular
2 - Return

paymentOnDelivery

parties

Lines.

**Remarks:**

*Between 1 and 999 lines. Total packages across all lines must be between 1 and 10000.*

lines

payments

Price snapshots for the shipment, such as a checkout estimate, a booking price, or a carrier-confirmed price received in an event. A shipment can have several. The most recent price1Detail.pricingDate is the current price.

**Remarks:**

*Each item is validated.*

prices

messages

articles

binaryAttachments

attributes

International commercial terms.

**Remarks:**

*Cannot be Unknown when provided.*

incoterms

Customs declaration headers for the shipment, one entry per (proforma) invoice.

**Remarks:**

*Validated when provided.*

customs

Dangerous goods declaration for the shipment.

**Remarks:**

*Validated when provided.*

dangerousGoods

relations

emissions

<p class="slate-p " >Fetches a binary attachment on a Shipment, such as a label or proof of delivery. Provide <code class="slate-code">shipmentUuid</code> and <code class="slate-code">binaryUuid</code>. Returns the file as a stream, or a JSON envelope when the <code class="slate-code">Accept</code> header contains <code class="slate-code">application/json</code>.</p>

Fetches a binary attachment on a Shipment, such as a label or proof of delivery. Provide 

. Returns the file as a stream, or a JSON envelope when the 

Get shipment attachment

binaryUuid

The attachment file as a binary stream, or a JSON envelope when the Accept header contains application/json

Sections