1"use strict";(self.webpackChunk_curri_docs=self.webpackChunk_curri_docs||[]).push([[6962],{9675:(e,r,i)=>{i.r(r),i.d(r,{assets:()=>c,contentTitle:()=>a,default:()=>o,frontMatter:()=>d,metadata:()=>t,toc:()=>l});const t=JSON.parse('{"id":"itineraries/queries-and-mutations/get-itinerary","title":"Get Itinerary","description":"itinerary Query","source":"@site/docs/itineraries/queries-and-mutations/04-get-itinerary.md","sourceDirName":"itineraries/queries-and-mutations","slug":"/itineraries/queries-and-mutations/get-itinerary","permalink":"/docs/itineraries/queries-and-mutations/get-itinerary","draft":false,"unlisted":true,"tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"title":"Get Itinerary","hide_title":true,"unlisted":true}}');var n=i(678),s=i(9787);const d={title:"Get Itinerary",hide_title:!0,unlisted:!0},a="Get an Itinerary",c={},l=[{value:"<code>itinerary</code> Query",id:"itinerary-query",level:2},{value:"The <code>Itinerary</code> Response Object",id:"the-itinerary-response-object",level:2},{value:"Response Fields",id:"response-fields",level:3},{value:"Fields",id:"fields",level:4},{value:"Examples",id:"examples",level:2},{value:"Get a previously created itinerary",id:"get-a-previously-created-itinerary",level:3}];function h(e){const r={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"get-an-itinerary",children:"Get an Itinerary"})}),"\n",(0,n.jsxs)(r.h2,{id:"itinerary-query",children:[(0,n.jsx)(r.code,{children:"itinerary"})," Query"]}),"\n",(0,n.jsxs)(r.p,{children:["The ",(0,n.jsx)(r.code,{children:"itinerary"})," query is used to retrieve an itinerary by its ",(0,n.jsx)(r.code,{children:"id"}),". This will be the ",(0,n.jsx)(r.code,{children:"id"})," returned from the ",(0,n.jsxs)(r.a,{href:"/docs/itineraries/queries-and-mutations/book-itinerary",children:[(0,n.jsx)(r.code,{children:"bookItinerary"})," mutation"]}),"."]}),"\n",(0,n.jsxs)(r.h2,{id:"the-itinerary-response-object",children:["The ",(0,n.jsx)(r.code,{children:"Itinerary"})," Response Object"]}),"\n",(0,n.jsxs)(r.p,{children:["The ",(0,n.jsx)(r.code,{children:"Itinerary"})," type implements the ",(0,n.jsx)(r.code,{children:"ExternalIDProvider"})," interface and is used to represent an itinerary with various information such as stops, start times, status, and quotes."]}),"\n",(0,n.jsx)(r.h3,{id:"response-fields",children:"Response Fields"}),"\n",(0,n.jsx)(r.p,{children:"The following fields can be requested:"}),"\n",(0,n.jsx)(r.h4,{id:"fields",children:"Fields"}),"\n",(0,n.jsxs)(r.table,{children:[(0,n.jsx)(r.thead,{children:(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.th,{children:"Field Name"}),(0,n.jsx)(r.th,{children:"Type"}),(0,n.jsx)(r.th,{children:"Description"})]})}),(0,n.jsxs)(r.tbody,{children:[(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"id"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#custom-scalar-types",children:(0,n.jsx)(r.code,{children:"IDCustomScalar"})})}),(0,n.jsx)(r.td,{children:"ID of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"name"}),(0,n.jsx)(r.td,{children:"String"}),(0,n.jsx)(r.td,{children:"Name of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"accountId"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#custom-scalar-types",children:(0,n.jsx)(r.code,{children:"IDCustomScalar"})})}),(0,n.jsx)(r.td,{children:"ID of the associated account"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"originatingUserId"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#custom-scalar-types",children:(0,n.jsx)(r.code,{children:"IDCustomScalar"})})}),(0,n.jsx)(r.td,{children:"ID of the originating user"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"stops"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#stop",children:(0,n.jsx)(r.code,{children:"[Stop]"})})}),(0,n.jsx)(r.td,{children:"List of stops"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"primaryItineraryDriver"}),(0,n.jsx)(r.td,{children:"ItineraryDriver"}),(0,n.jsx)(r.td,{children:"Primary itinerary driver"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"requestedDeliveryMethod"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#deliverymethod",children:(0,n.jsx)(r.code,{children:"DeliveryMethod"})})}),(0,n.jsx)(r.td,{children:"Requested delivery method"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"status"}),(0,n.jsx)(r.td,{children:"String"}),(0,n.jsx)(r.td,{children:"Status of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"itineraryPriority"}),(0,n.jsx)(r.td,{children:"String"}),(0,n.jsx)(r.td,{children:"Priority of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"estimatedDeliveryAt"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#custom-scalar-types",children:(0,n.jsx)(r.code,{children:"DateTimeCustomScalar"})})}),(0,n.jsx)(r.td,{children:"Estimated delivery time of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"startedAt"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#custom-scalar-types",children:(0,n.jsx)(r.code,{children:"DateTimeCustomScalar"})})}),(0,n.jsx)(r.td,{children:"Start time of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"completedAt"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#custom-scalar-types",children:(0,n.jsx)(r.code,{children:"DateTimeCustomScalar"})})}),(0,n.jsx)(r.td,{children:"Completion time of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"scheduledStart"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#custom-scalar-types",children:(0,n.jsx)(r.code,{children:"DateTimeCustomScalar"})})}),(0,n.jsx)(r.td,{children:"Scheduled start time of the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"stopCount"}),(0,n.jsx)(r.td,{children:"Int"}),(0,n.jsx)(r.td,{children:"Number of stops in the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"currentStopNumber"}),(0,n.jsx)(r.td,{children:"Int"}),(0,n.jsx)(r.td,{children:"Current stop number in the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"itineraryQuote"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#itineraryquote",children:(0,n.jsx)(r.code,{children:"ItineraryQuote"})})}),(0,n.jsx)(r.td,{children:"Quote for the itinerary"})]}),(0,n.jsxs)(r.tr,{children:[(0,n.jsx)(r.td,{children:"estimates"}),(0,n.jsx)(r.td,{children:(0,n.jsx)(r.a,{href:"./itinerary-appendix#computeditineraryquote",children:(0,n.jsx)(r.code,{children:"[ComputedItineraryQuote]"})})}),(0,n.jsx)(r.td,{children:"List of computed itinerary quotes"})]})]})]}),"\n",(0,n.jsx)(r.h2,{id:"examples",children:"Examples"}),"\n",(0,n.jsx)(r.h3,{id:"get-a-previously-created-itinerary",children:"Get a previously created itinerary"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-graphql",children:'query {\n itinerary(itineraryId: "it_1234ABCDEF") {\n id\n name\n accountId\n itineraryPriority\n stopCount\n stops {\n id\n address {\n addressLine1\n city\n state\n postalCode\n }\n }\n }\n}\n'})}),"\n",(0,n.jsxs)("nav",{class:"pagination-nav temp-nav",children:[(0,n.jsxs)("a",{href:"/docs/itineraries/queries-and-mutations/book-itinerary",class:"pagination-nav__link pagination-nav__link--prev",children:[(0,n.jsx)("div",{class:"pagination-nav__sublabel",children:"Previous"}),(0,n.jsx)("div",{class:"pagination-nav__label",children:"Book an Itinerary"})]}),(0,n.jsxs)("a",{href:"/docs/itineraries/queries-and-mutations/cancel-itinerary",class:"pagination-nav__link pagination-nav__link--next",children:[(0,n.jsx)("div",{class:"pagination-nav__sublabel",children:"Next"}),(0,n.jsx)("div",{class:"pagination-nav__label",children:"Cancel an Itinerary"})]})]})]})}function o(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},9787:(e,r,i)=>{i.d(r,{R:()=>d,x:()=>a});var t=i(6166);const n={},s=t.createContext(n);function d(e){const r=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:d(e.components),t.createElement(s.Provider,{value:r},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.