From 85e6338ef594dcedbb1e5180da6f18d5a6a7d666 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:07:10 -0400 Subject: [PATCH 01/89] Add files via upload --- Forwarding.yaml | 4445 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 4445 insertions(+) create mode 100644 Forwarding.yaml diff --git a/Forwarding.yaml b/Forwarding.yaml new file mode 100644 index 0000000..e9103e0 --- /dev/null +++ b/Forwarding.yaml @@ -0,0 +1,4445 @@ +openapi: 3.1.0 +info: + title: Forwarding API v1 + version: "1.0" + description: | + Links the UPS Forarding Hub to backend applications for the management of ocean and air freight shipments. + + **Key Business Values:** + - UPS Forwarding Hub APIs unify ocean and air freight through a single, modern RESTful interface. + - They accelerate time to market with simplified, scalable integration. + - Real-time rate quotes and booking enhance the customer experience. + - Built-in tracking and visibility tools improve shipment transparency. + - Streamlined documentation and developer support reduce onboarding time + + NOTE: Please contact for GUID support +servers: + - url: https://www.onlinetools.ups.com/api/forwarding/{version} + description: URL for OAuth based authentication that can be used for the UPS Production environment. + variables: + version: + description: Denotes which version of the API to be called as new features are released. + default: v1 + enum: + - v1 + - url: https://www.onlinetoolsuat.ups.com/api/forwarding/{version} + description: URL for OAuth based authentication that can be used for the UPS Staging environment. + variables: + version: + description: Denotes which version of the API to be called as new features are released. + default: v1 + enum: + - v1 +tags: + - name: Orders + description: Endpoints related to shipments not yet submitted for processing + - name: Rate + description: Endpoints related to Rating + - name: Ship + description: Endpoints related to shipments in process + - name: Info + description: Endpoints related to Information + - name: Payment + description: Endpoints related to Payments +security: + - oauth2: [] +paths: + /air/rate: + post: + description: Generate Air Freight rates based on the provided shipment, Shipper/Consignee/Payor, and Cargo details. + operationId: Air Freight Rating + tags: + - Forwarding + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirFreightRateRequestV1" + example: + shipper: + company: Philip + account: "987654321" + address1: 12380 MORRIS RD + city: SHREWSBURY + state: NJ + postalCode: "7702" + countryCode: US + serviceCenterCode: SDF + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: Michael + contactPhone: "999999999" + contactEmail: test@gmail.com + details: + - key: serialNumber + value: SN654321 + consignee: + company: Ship To Philip + account: 442Y + address1: 45678 MAIN ST + city: NEWARK + state: NJ + postalCode: "07102" + countryCode: US + serviceCenterCode: EWR + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: Sarah + contactPhone: "888888888" + contactEmail: sarah@example.com + details: + - key: serialNumber + value: SN654321 + thirdParty: + company: Third Party Logistics + account: "123456789" + address1: 7890 LOGISTICS RD + address2: "" + address3: "" + city: ATLANTA + state: GA + postalCode: "30303" + countryCode: US + serviceCenterCode: ATL + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: John + contactPhone: "777777777" + contactEmail: john@example.com + details: + - key: serialNumber + value: SN654321 + shipment: + shipmentNumber: "9100010271" + serviceType: AM + paymentType: PPD + pickupDate: 2025-04-24 + readyTime: 09:15:59 + closeTime: 17:02:59 + dropoffTime: 18:00:00 + weight: 54 + freightType: PALLET + isMetric: false + description: Shipment of electronics + shipperReference: SHIP123 + consigneeReference: CON123 + currencyCode: USD + requestPickup: true + requestBoL: true + countryOfManufacture: + - US + - MX + - CA + items: + - description: Laptop + count: 1 + length: 15 + width: 10 + height: 1 + weight: 5 + details: + - key: serialNumber + value: SN654321 + - description: Monitor + count: 1 + length: 24 + width: 18 + height: 5 + weight: 15 + details: + - key: serialNumber + value: SN654321 + details: + - key: HAZMAT + value: "true" + - key: DV + value: "1000" + - key: DV-Currency + value: USD + language: en-US + transactionId: TXT123432 + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirFreightRateResponseV1" + example: + response: + rates: + - serviceType: AM + guaranteedDelivery: true + deliveryTime: "2025-05-14 12:00:00" + holdAtAirportTime: "2025-05-14 17:00:00" + totalCharge: + code: AF + description: Air Freight + amount: "1170.71" + currencyCode: USD + currencyCode: USD + billableWeight: 151 + weightUnit: LBS + dimensionalWeight: 47 + minimumBillableWeightApplied: true + contractRate: false + charges: + - role: Carrier + code: FRT + description: Air Freight Shipping - Included + amount: 250.75 + currencyCode: USD + - role: Agent + code: FEE + description: Fuel Surcharge - Included + amount: 45.00 + currencyCode: USD + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /air/orders: + post: + operationId: Create Order + description: Cretae a pending order which becomes a shipment when processed at end-of-day + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + tags: + - Forwarding + requestBody: + required: true + description: Container for shipment & package details to be made into an order. + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloOrderRequestV1" + example: + shipper: + account: 4492YY + serviceCenterCode: SDF + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + details: + - key: ConsolidationId + value: ConsolidationTest + - key: Landmark + value: Behind Twin Tower + - key: AlternateNumber + value: "9876665341" + company: GEMINI SYSTEM INFORMATION + address1: 12380 MORRIS RD + city: Louisville + state: KY + postalCode: "40214" + countryCode: US + consignee: + account: 5503YY + serviceCenterCode: BOS + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: Sheldon + contactPhone: "8888888778" + contactEmail: test2@ups.com + details: + - key: AlternateNumber + value: "9877775341" + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + thirdParty: + account: 3206YY + serviceCenterCode: BOS + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: Hardy + contactPhone: "999999999" + contactEmail: test3@ups.com + details: + - key: Landmark + value: Besides Ammy Library + - key: AlternateNumber + value: "9853325341" + company: ABC LTD. + address1: 52 June Street + address2: "" + address3: "" + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + shipment: + shipmentNumber: "9100010271" + serviceType: AM + paymentType: PPD + pickupDate: 2025-07-24 + readyTime: 20:00:00 + closeTime: 22:00:00 + dropoffTime: 21:00:00 + weight: 54 + freightType: PALLET + orderDescription: WIDGETS + shipperReference: ABC123 + consigneeReference: Z30010021 + currency: USD + isMetric: false + items: + - + - key: itemDescription + value: White Leather Men's Sneakers + - key: count + value: "1" + - key: length + value: "10" + - key: width + value: "18" + - key: height + value: "10" + - key: weight + value: "26" + - + - key: itemDescription + value: Green floral midi female dress. + - key: count + value: "1" + - key: length + value: "10" + - key: width + value: "18" + - key: height + value: "10" + - key: weight + value: "26" + countryOfManufacture: + - US + - MX + - CA + - GBR + details: + - key: HAZMAT + value: "false" + - key: HAPU + value: "true" + - key: SAT + value: "false" + - key: CC + value: "false" + - key: CV + value: "0" + - key: CV-Currency + value: "USD" + - key: DV + value: "1000" + - key: DV-Currency + value: "USD" + - key: PICKUP + value: "true" + - key: DDU + value: "false" + - key: DDP + value: "false" + - key: RESPU + value: "true" + - key: RESDLV + value: "true" + - key: LIFTGTPU + value: "true" + - key: LIFTGTDLV + value: "true" + label: + layout: AF-GEMINI + format: PDF + details: + - key: model_number + value: "123543" + - key: model_year + value: "2023" + language: en-US + transId: TXN123456789 + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloOrderResponseV1" + example: + shipmentNumber: "9100010271" + orderNumber: "9100010270001" + labelFormat: DATA + charges: + shipperCharges: + - code: AF + description: Air Freight + amount: "10.00" + currencyCode: USD + consigneeCharges: + - code: DL + description: Delivery Charges + amount: "10.00" + currencyCode: USD + labelData: + shipper: + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" + countryCode: US + account: 1420YY + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + consignee: + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" + countryCode: US + account: 1420YY + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + shipment: + shipmentNumber: "9100010271" + serviceType: AM + paymentType: PPD + pickupDate: 2025-10-22 + readyTime: 11:00:00 + closeTime: 17:00:00 + dropoffTime: 11:10:00 + weight: 54 + freightType: PALLET + orderDescription: Apparels + shipperReference: Z30010021 + consigneeReference: ABC123 + currency: USD + isMetric: "0" + countryOfManufacture: + - US + - MX + - CA + - GB + details: + - key: HAZMAT + value: "false" + - key: HAPU + value: "true" + - key: SAT + value: "false" + - key: CC + value: "false" + - key: CV + value: "0" + - key: CV-Currency + value: "USD" + - key: DV + value: "1000" + - key: DV-Currency + value: "USD" + - key: PICKUP + value: "true" + - key: DDU + value: "false" + - key: DDP + value: "false" + - key: RESPU + value: "true" + - key: RESDLV + value: "true" + - key: LIFTGTPU + value: "true" + - key: LIFTGTDLV + value: "true" + rates: + amount: 1526.74 + currencyCode: USD + sortCode: U-BOS + gateway: ATL + count: 2 + labelService: ND + serviceDesc: UPS Next Day Air Freight - NGS + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + delete: + operationId: Cancel Order + tags: + - Forwarding + description: Cancel an pending order + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + description: Container for order details to be deleted. + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloCancelOrderRequestV1" + example: + account: 4492YY + orderNumber: "3912088430001" + language: en-US + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloCancelOrderResponseV1" + example: + shipmentNumber: "9100010271" + orderNumber: "9100010270001" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Order Not Found + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /air/orders/print-label: + post: + operationId: Print Label + tags: + - Forwarding + description: Re-Print label for an existing Order + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + description: Container for label details to be reprinted. + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloOrderPrintLabelRequestV1" + example: + shipperAccountNumber: 4492YY + orderNumber: "9100005950005" + format: PDF + layout: AF-GEMINI + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloLabelV1" + examples: + PDFPNG: + summary: PDF or PNG + value: + labelFormat: PDF + shipmentNumber: "9100010271" + orderNumber: "9100010270001" + charges: + shipperCharges: + - code: AF + description: Air Freight + amount: "10.00" + currencyCode: USD + consigneeCharges: + - code: DL + description: Delivery Charges + amount: "10.00" + currencyCode: USD + labelImage: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== + DATA: + value: + labelFormat: DATA + shipmentNumber: "9100010271" + orderNumber: "9100010270001" + charges: + shipperCharges: + - code: AF + description: Air Freight + amount: "10.00" + currencyCode: USD + consigneeCharges: + - code: DL + description: Delivery Charges + amount: "10.00" + currencyCode: USD + labelData: + shipper: + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" + countryCode: US + account: 1420YY + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + consignee: + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" + countryCode: US + account: 1420YY + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + shipment: + shipmentNumber: "9100010271" + serviceType: AM + paymentType: PPD + pickupDate: 2025-10-22 + readyTime: 11:00:00 + closeTime: 17:00:00 + dropoffTime: 11:10:00 + weight: 54 + freightType: PALLET + orderDescription: Apparels + shipperReference: Z30010021 + consigneeReference: ABC123 + currency: USD + isMetric: "0" + countryOfManufacture: + - US + - MX + - CA + - GB + details: + - key: HAZMAT + value: "false" + - key: HAPU + value: "true" + - key: SAT + value: "false" + - key: CC + value: "false" + - key: CV + value: "0" + - key: CV-Currency + value: "USD" + - key: DV + value: "1000" + - key: DV-Currency + value: "USD" + - key: PICKUP + value: "true" + - key: DDU + value: "false" + - key: DDP + value: "false" + - key: RESPU + value: "true" + - key: RESDLV + value: "true" + - key: LIFTGTPU + value: "true" + - key: LIFTGTDLV + value: "true" + rates: + amount: 1526.74 + currencyCode: USD + sortCode: U-BOS + gateway: ATL + count: 2 + labelService: ND + serviceDesc: UPS Next Day Air Freight - NGS + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /air/orders/postpone: + patch: + operationId: Postpone Order + tags: + - Forwarding + description: Postpone one or all orders from a shipper to a future date. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: shipper_account_number + in: query + description: Unique shipper number. Required for all updates. + required: true + schema: + type: string + example: 4492YY + - name: order_number + in: query + description: Unique order number. Required for individual order updates. + required: false + schema: + type: string + example: "3912088430001" + - name: language + in: query + description: Unique order number. Optional for all updates. + required: false + schema: + type: string + example: "en-US" + requestBody: + required: true + description: Container for the order details to be postponed. + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloOrderPostponeRequestV1" + example: + - op: replace + path: /newDate + value: 2025-07-24 + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloOrderPostponeResponseV1" + example: + shipmentNumber: "9100010270001" + orderNumber: "910001027" + newDate: 2025-10-22 + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /air/orders/search: + post: + operationId: Search Order + tags: + - Forwarding + description: Search for orders based on criteria + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + description: Container for filters to be applied to the search. + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloOrderSearchRequestV1" + example: + shipperAccountNumber: 4492YY + criteriaList: + - criteriaField: ORDER_STATUS + criteriaOperator: NOTEQ + criteriaValue: "8" + - criteriaField: SHIP_DATE + criteriaOperator: BTWN + criteriaValue: 2025-07-23 + criteriaValue2: 2025-07-24 + language: en-US + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloOrderSearchResponseV1" + example: + orders: + - shipmentNumber: "906694886" + orderNumber: "9066948860001" + consignee: + account: 4492YY + serviceCenterCode: BOS + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: Sheldon + contactPhone: "8888888778" + contactEmail: test2@ups.com + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + shipDate: 2025-07-24 + statusCode: 8 + status: Posted + description: LOTS OF STUFF + manifestNumber: M934567890 + shipperReference: SHIPPER REF + consigneeReference: CONSIGNEE REF + isMetric: true + items: + totalWeight: 14 + weightUnit: LB + totalPieceCount: 2 + item: + - count: 1 + length: 10 + width: 10 + height: 10 + weight: 10 + - count: 1 + length: 10 + width: 10 + height: 10 + weight: 10 + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /air/shipment: + post: + operationId: Submit Air Shipment + tags: + - Forwarding + description: Processes all the shipment created for the particular shipper for the day and return a manifest. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + description: The request containing required details for processing submit request. + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirShipmentSubmitRequestV1" + example: + account: 4492YY + pickupDate: 2025-07-24 + requestManifest: true + manifestFormat: PDF + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirShipmentDataResponseV1" + example: + account: 4492YY + pickupDate: 2025-07-24 + shipmentCount: 1 + pieceCount: 2 + weight: 200 + weightUnit: LBS + manifest: + manifestNumber: M810000091 + manifestFormat: DATA + shipper: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: GEMINI SYSTEM INFORMATION + address1: 12380 MORRIS RD + city: Louisville + state: KY + postalCode: "40214" + countryCode: US + shipments: + - number: 1 + shipmentNumber: "9100010271" + serviceType: AM + paymentType: OTH/THD + weight: 54 + currency: USD + shipperReference: "36566355" + consigneeReference: "BATCH NO: B35" + consignee: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + address2: "" + address3: "" + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + summary: + services: + - serviceCode: CX + serviceName: UPS Express® Freight + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 55 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + - serviceCode: D2 + serviceName: UPS 2nd Day Air® Freight NGS + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 45.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + serviceTotal: + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 100.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + dailyPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + currentPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + delete: + operationId: Cancel Air Shipment + tags: + - Forwarding + description: Cancels a shipment based on the shipment number and shipper account number provided in the request. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirShipmentCancelRequestV1" + example: + shipperAccountNumber: 4492YY + shipmentNumber: "391208843" + language: en-US + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirShipmentCancelResponseV1" + example: + shipperAccountNumber: 4492YY + shipmentNumber: "9100010271" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: The requested resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + get: + operationId: Print Air Manifest + tags: + - Forwarding + description: Generates and returns the manifest for the specified manifest number in the requested format. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: account_number + in: query + description: Shipper Account Number + required: true + schema: + type: string + example: 4492YY + - name: manifest_number + in: query + description: Manifest Number + required: true + schema: + type: string + example: M810000079 + - name: manifest_format + in: query + description: Manifest Format + required: true + schema: + type: string + enum: + - DATA + - name: language + in: query + description: Language + required: true + schema: + type: string + example: en-US + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirShipmentDataResponseV1" + example: + account: 4492YY + pickupDate: 2025-07-24 + shipmentCount: 1 + pieceCount: 2 + weight: 200 + weightUnit: LBS + manifest: + manifestNumber: M810000091 + manifestFormat: DATA + shipper: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: GEMINI SYSTEM INFORMATION + address1: 12380 MORRIS RD + address2: "" + address3: "" + city: Louisville + state: KY + postalCode: "40214" + countryCode: US + shipments: + - number: 1 + shipmentNumber: "9100010271" + serviceType: AM + paymentType: OTH/THD + weight: 54 + orderDescription: "Lots of Stuff" + currency: USD + shipperReference: Z30010021 + consigneeReference: ABC123 + consignee: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + address2: "" + address3: "" + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + summary: + services: + - serviceCode: CX + serviceName: UPS Express® Freight + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 55 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + - serviceCode: D2 + serviceName: UPS 2nd Day Air® Freight NGS + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 45.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + serviceTotal: + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 100.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + dailyPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + currentPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "9999" + message: The requested resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /air/utility/city-details: + get: + operationId: getCity + tags: + - Forwarding + summary: City Data + description: This endpoint retrieves the city details based on the search criteria provided. + parameters: + - name: shipper_accountnumber + in: query + schema: + type: string + - name: country + in: query + schema: + type: string + - name: city + in: query + schema: + type: string + - name: criteria_operator + in: query + schema: + type: string + - name: postal + in: query + schema: + type: string + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloGetCityResponseV1" + example: + cityDetails: + - stateProvinceCode: GA + cityName: ATLANTA + majorAirportCity: YVR + tariffDestination: ATL + sortCode: V1 + standardService: BND + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "9999" + message: The requested resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /payment/status/{session_id}: + patch: + summary: Status of payment authorizations + description: | + Provides a mechanism for Common Payment Capture (CPC) to send, in real-time, payment status to the Forwarding Hub. + + **Key Business Values** + - Supplements the CPC Pay-by-Link functionality + - Enhances user experience by automating payment status tracking. + - Reduces server load by eliminating repeated manual checks for status updates. + operationId: putPaymentAuthStatus + security: + - oauth2: [] + tags: + - Forwarding + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - name: session_id + in: path + description: The identifier for the session the payment was made in. + required: true + schema: + type: string + minLength: 32 + maxLength: 36 + pattern: ^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$ + example: 1acbd41c-13fb-41c0-85f3-1954d69fa22e + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApolloPaymentPatchV1' + examples: + payment-status-success: + summary: Successful Payment + value: + - op: add + path: /cardAuthStatus + value: '20001' + - op: add + path: /paymentGUID + value: 3437bfbe-fd57-4e50-9802-493b128c63e5 + payment-status-failure: + summary: Failed Payment + value: + - op: add + path: /cardAuthStatus + value: '40001' + responses: + "204": + description: Accepted + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1000" + message: Malformed JSON syntax + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1004" + message: The provided session_id resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error +components: + securitySchemes: + oauth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token + scopes: {} + parameters: + transId: + name: transId + in: header + description: Unique transaction ID for debugging and tracking. + required: false + schema: + type: string + example: N29245123456789 + transactionSrc: + name: transactionSrc + in: header + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + pattern: ^[a-zA-Z0-9-.]{1,36}$ + minLength: 1 + maxLength: 36 + example: GlobalAdvisor + Content-Type: + name: Content-Type + in: header + description: The Content-Type header provides the client with the actual content/media type of the returned content. + required: true + schema: + type: string + example: application/json + X-BusinessGUID: + name: X-BusinessGUID + in: header + description: Unique business GUID. + required: true + schema: + type: string + minLength: 36 + maxLength: 36 + pattern: '^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$' + example: 63A70EB9-3BB5-4617-A659-09D2E7027A85 + X-ClientId: + name: X-ClientId + in: header + description: Unique client Id. + required: true + schema: + type: string + example: N45123456789 + headers: + BkndTransId: + description: The backend transaction id. + required: true + schema: + type: string + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + required: true + schema: + type: string + minLength: 3 + maxLength: 36 + pattern: ^[a-zA-Z0-9-.]{3,36}$ + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + required: true + schema: + type: string + minLength: 1 + maxLength: 36 + pattern: ^[a-zA-Z0-9-.]{1,36}$ + example: UPS.com + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + required: true + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + required: true + schema: + type: string + example: UJ0001 + APIErrorMsg: + description: The API error message. + required: true + schema: + type: string + example: Invalid token or token is not present. + X-ClientId: + description: Unique client Id. + required: true + schema: + type: string + example: N45123456789 + X-BusinessGUID: + description: Unique business GUID. + required: true + schema: + type: string + minLength: 36 + maxLength: 36 + pattern: '^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$' + example: 63A70EB9-3BB5-4617-A659-09D2E7027A85 + schemas: + #/air/rate + ApolloAirFreightRateRequestV1: + description: Request to generate Air Freight rates for a shipment. + type: object + required: + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloPartyV1" + consignee: + $ref: "#/components/schemas/ApolloPartyV1" + thirdParty: + $ref: "#/components/schemas/ApolloPartyV1" + shipment: + type: object + description: Shipment information for rate calculation. + required: + - paymentType + - freightType + - items + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + type: string + description: Type of service requested + oneOf: + - title: Next Day Non-Guaranteed + const: AM + - title: Next Day Guaranteed + const: AMG + - title: Second Day Non-Guaranteed + const: D2 + - title: Second Day Guaranteed + const: D2G + - title: Three Day Non-Guaranteed + const: DF + - title: Three Day Guaranteed + const: DFG + - title: Direct + const: CA + - title: Consolidated + const: EC + - title: Premium + const: CX + paymentType: + type: string + description: Payment type. + oneOf: + - title: Prepaid + const: PPD + - title: Collect + const: COL + - title: Third Party + const: THD + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The RFC 3339 pickup ready time. + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The RFC 3339 location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The RFC 3339 shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. + format: float + maximum: 999999.99 + examples: + - 54 + - 10.32 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + - LOOSE + isMetric: + type: boolean + description: Indicates whether the shipment uses metric units of measurement. + default: false + description: + type: string + description: Description of the shipment. + example: Shipment of electronics + shipperReference: + type: string + description: Reference number provided by the shipper. + example: SHIP123 + consigneeReference: + type: string + description: Reference number provided by the consignee. + example: CON123 + currencyCode: + type: string + description: The ISO 4217 shipment currency code + minLength: 3 + maxLength: 3 + pattern: '^[A-Z]{3}' + example: USD + requestPickup: + type: boolean + description: Indicates whether a pickup request is included. + default: false + requestBoL: + type: boolean + description: Indicates whether a Bill of Lading (BoL) is requested. + default: false + countryOfManufacture: + type: array + description: The unbounded list of country codes where the goods were manufactured. + minItems: 1 + items: + description: | + The ISO 3166 + code of the country participating in the goods manufacture. + $ref: "#/components/schemas/ApolloCountryCodeV1" + items: + type: array + description: Unbounded list of items in the shipment. + minItems: 1 + items: + type: object + description: Item information within a shipment. + required: + - count + - length + - width + - height + - weight + properties: + description: + type: string + description: Description of the item. + example: Laptop + count: + type: integer + description: Quantity of the item. + maximum: 99999 + example: 1 + length: + description: Length of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + width: + description: Width of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + height: + description: Height of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + weight: + type: number + format: float + description: Weight of the item. + minimum: 0.1 + maximum: 999999.99 + examples: + - 15 + - 6.84 + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + language: + type: string + description: Language preference for the response. + example: en-US + transactionId: + type: string + description: Unique transaction ID for debugging and tracking. + example: N29245123456789 + additionalProperties: false + ApolloAirFreightRateResponseV1: + type: object + description: This object provides the rate calculation response. + required: + - response + properties: + response: + type: object + required: + - rates + properties: + rates: + type: array + description: Unbounded list of calculated rates. + minItems: 1 + items: + type: object + description: Details of a calculated rate. + required: + - serviceType + - guaranteedDelivery + - deliveryTime + - holdAtAirportTime + - totalCharge + - currencyCode + - billableWeight + - weightUnit + - dimensionalWeight + - minimumBillableWeightApplied + - contractRate + - charges + properties: + serviceType: + type: string + description: Service type for the rate. + example: AM + guaranteedDelivery: + type: boolean + description: Indicates if delivery is guaranteed. + default: false + deliveryTime: + description: The estimated delivery time. + $ref: "#/components/schemas/ApolloDateTimeV1" + holdAtAirportTime: + description: The hold at airport time. + $ref: "#/components/schemas/ApolloDateTimeV1" + totalCharge: + description: Total charge for the shipment. + $ref: "#/components/schemas/ApolloChargeV1" + currencyCode: + type: string + description: Currency code for the rate. + example: USD + billableWeight: + description: The billable weight. + $ref: "#/components/schemas/ApolloWeightV1" + weightUnit: + type: string + description: The Weight unit used. + enum: + - LBS + - KGS + dimensionalWeight: + description: The dimensional weight. + $ref: "#/components/schemas/ApolloWeightV1" + minimumBillableWeightApplied: + type: boolean + description: Indicates if the minimum billable weight was applied. + default: false + contractRate: + type: boolean + description: Indicates if the contract rate applies. + default: false + charges: + type: array + minItems: 1 + description: Unbounded list of charges applied + items: + type: object + properties: + role: + type: string + description: The role of charge + example: Carrier + code: + type: string + description: The charge code + example: FRT + description: + type: string + description: The charge Description + example: Air Freight Shipping - Included + amount: + type: number + description: The charge amount + example: 250.75 + currencyCode: + type: string + description: The type of currency associated with the charge + example: USD + additionalProperties: false + additionalProperties: false + + #/air/orders + ApolloOrderRequestV1: + type: object + required: + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Shipper associated with the Shipment. + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Consignee associated with the Shipment. + thirdParty: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Any other Party involved in the Shipment, usually a payor + shipment: + type: object + required: + - pickupDate + - freightType + - items + - currency + - isMetric + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + type: + - string + - "null" + example: AM + paymentType: + description: Type of service requested + type: + - string + - "null" + maxLength: 4 + example: PPD + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The pickup ready time. + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. + format: float + maximum: 999999.99 + example: 54 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + - LOOSE + orderDescription: + description: A short description of the Shipment Order + type: + - string + - "null" + example: WIDGETS + shipperReference: + description: A reference reference to the shipment provided by the Shipper + type: + - string + - "null" + example: ABC123 + consigneeReference: + description: A reference reference to the shipment provided by the Consignee + type: + - string + - "null" + example: Z30010021 + currency: + description: The currency code associated with the Shipment + type: + - string + - "null" + example: USD + isMetric: + description: A flag to indicate if the measurements are metric + type: + - boolean + - "null" + default: false + items: + type: array + description: A collection of the details of each item that is associated with the Shipment + minItems: 1 + items: + $ref: "#/components/schemas/ApolloCustomArrayV1" + countryOfManufacture: + description: An unbounded array of country codes where the items originated + minItems: 1 + type: array + items: + type: + - string + - "null" + maxLength: 3 + example: US + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + label: + type: object + required: + - format + properties: + layout: + description: A key that determines the template that is used for the label. + type: + - string + - "null" + maxLength: 40 + example: AF-GEMINI + format: + description: The output format of the document. + type: + - string + - "null" + details: + description: Additional details needed for the label. May include the custom fields that the label template supports + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + language: + description: The language/culture that is being used for the API + type: string + maxLength: 6 + transId: + description: A transaction Id to track this API call + type: string + additionalProperties: false + ApolloOrderResponseV1: + allOf: + - $ref: "#/components/schemas/ApolloLabelV1" + - type: object + required: + - shipmentNumber + - orderNumber + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + additionalProperties: true + ApolloCancelOrderRequestV1: + description: The request used to cancel an Order + type: object + required: + - account + - orderNumber + - language + properties: + account: + description: The unique number that identifies the Shipment + type: + - string + - "null" + example: 4492YY + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + language: + description: The language/culture that is being used for the API + type: string + maxLength: 6 + example: en-US + additionalProperties: false + ApolloCancelOrderResponseV1: + description: The response from Order Cancel Operation + type: object + required: + - shipmentNumber + - orderNumber + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + additionalProperties: false + + #/air/orders/print-label + ApolloOrderPrintLabelRequestV1: + description: The API request used to print a Label + type: object + required: + - shipperAccountNumber + - orderNumber + - layout + - format + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + layout: + description: A key that determines the template that is used for the label. + type: + - string + - "null" + minLength: 1 + maxLength: 40 + example: AF-GEMINI + format: + description: The output format of the document. + type: + - string + - "null" + minLength: 1 + example: PDF + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + + #/air/orders/postpone: + ApolloOrderPostponeRequestV1: + type: array + description: The unbounded list of objects to change with their values + minItems: 1 + items: + type: object + required: + - op + - path + - value + properties: + op: + type: + - string + - "null" + enum: + - replace + path: + type: + - string + - "null" + description: the field whose value is to be changed + example: /newDate + value: + type: + - string + - "null" + description: new value to insert into the defined field + example: 2025-07-24 + additionalProperties: false + ApolloOrderPostponeResponseV1: + description: The response from the post pone operation + type: + - object + - "null" + required: + - shipmentNumber + - orderNumber + - newDate + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + newDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + + #/air/orders/search + ApolloOrderSearchRequestV1: + type: object + required: + - shipperAccountNumber + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + criteriaList: + description: An array of search criteria + type: + - array + - "null" + minItems: 1 + maxItems: 12 + items: + type: + - object + - "null" + required: + - criteriaField + - criteriaOperator + - criteriaValue + properties: + criteriaField: + description: The field that is used for search + type: + - string + - "null" + minLength: 1 + example: SHIP_DATE + criteriaOperator: + description: The Operator used in the search + type: + - string + - "null" + minLength: 1 + example: BTWN + criteriaValue: + description: The value that is used in the search + type: + - string + - "null" + minLength: 1 + example: "8" + criteriaValue2: + description: The value that is used in the search + type: + - string + - "null" + minLength: 1 + example: 2025-07-23 + additionalProperties: false + language: + description: The language/culture used in the request + type: + - string + - "null" + example: en-US + additionalProperties: false + ApolloOrderSearchResponseV1: + description: The response provided by the Apollo Order Search API + type: object + required: + - orders + properties: + orders: + type: array + minItems: 1 + maxItems: 5000 + items: + type: + - object + - "null" + required: + - shipmentNumber + - orderNumber + - consignee + - shipDate + - statusCode + - status + - description + - manifestNumber + - shipperReference + - consigneeReference + - isMetric + - items + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: The consignee associated with the Shipment + shipDate: + description: The RFC 3339 scheduled ship date. + $ref: "#/components/schemas/ApolloDateV1" + statusCode: + description: TThe code indicating the status of the Order + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 8 + status: + description: The description of the status of the Order + type: + - string + - "null" + minLength: 1 + example: POSTED + description: + description: The description of the Order + type: + - string + - "null" + minLength: 1 + example: Lots of stuff + manifestNumber: + description: The unique Id to identify the Manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + shipperReference: + description: The reference provided by Shipper + type: + - string + - "null" + minLength: 1 + example: SHIPPER REF + consigneeReference: + description: The reference provided by Consignee + type: + - string + - "null" + minLength: 1 + example: CONSIGNEE REF + isMetric: + description: The flag indicating whether the measurements are metric + type: boolean + default: false + items: + type: object + required: + - totalWeight + - weightUnit + - totalPieceCount + properties: + totalWeight: + description: The total weight of the Items in the Order + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 14 + weightUnit: + description: The tunits used to calculate weight + type: + - string + - "null" + enum: + - LB + totalPieceCount: + description: The total number of Pieces in the Order + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + item: + description: The unbounded array of individual items in the Order + type: array + minItems: 1 + items: + type: + - object + - "null" + required: + - count + - length + - width + - height + - weight + properties: + count: + description: The number of components in the item + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 1 + length: + description: The length of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + width: + description: The width of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + height: + description: The height of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + weight: + description: The weight of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + additionalProperties: false + additionalProperties: false + additionalProperties: false + additionalProperties: true + + #/air/shipment + ApolloAirShipmentSubmitRequestV1: + type: object + required: + - account + - pickupDate + properties: + account: + description: The Account Number that identifies the Shipper + type: + - string + - "null" + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + requestManifest: + description: A flag indicating whether the manifest should be including in the response + type: boolean + default: false + manifestFormat: + description: The Output format for the manifest + type: + - string + - "null" + additionalProperties: false + ApolloAirShipmentDataResponseV1: + type: object + required: + - account + - pickupDate + - shipmentCount + - pieceCount + - weight + - weightUnit + - manifest + properties: + account: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + shipmentCount: + description: The count of all Shipments that are submitted for processing + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + pieceCount: + description: The count of all peieces in all the shipments submitted + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + weight: + description: The total weight of all the shipments + type: number + format: float + minimum: 1 + minLength: 1 + example: 2 + weightUnit: + description: The unit used to measure the weight + type: + - string + - "null" + manifest: + description: The manifest data that is returned if the format chosen is data + type: object + required: + - manifestNumber + - manifestFormat + - shipper + - shipments + properties: + manifestNumber: + description: The unique number used to identify a manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + manifestFormat: + description: The output format of the manifest + type: + - string + - "null" + minLength: 1 + example: PDF + shipper: + $ref: "#/components/schemas/ApolloShipmentAddressV1" + shipments: + description: An array of shipment details included in the manifest + type: + - array + - "null" + items: + type: + - object + - "null" + required: + - number + - shipmentNumber + - serviceType + - paymentType + - weight + - currency + - consignee + properties: + number: + description: The index of the shipment + type: integer + format: int32 + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + description: The service type used in the Shipment + type: + - string + - "null" + minLength: 1 + example: AM + paymentType: + description: The Payment type used in the shipment + type: + - string + - "null" + minLength: 1 + example: PPD + weight: + description: The total weight of the shipment + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + orderDescription: + description: A short description of the Order + type: + - string + - "null" + minLength: 1 + example: WIDGETS + currency: + description: The Acurrency used in the shipment + type: + - string + - "null" + minLength: 3 + maxLength: 3 + example: USD + shipperReference: + description: The reference provided by the shipper for the shipment + type: + - string + - "null" + minLength: 1 + example: ABC123 + consigneeReference: + description: The reference provided by the consignee for the shipment + type: + - string + - "null" + minLength: 1 + example: Z30010021 + consignee: + $ref: "#/components/schemas/ApolloShipmentAddressV1" + additionalProperties: false + summary: + type: object + required: + - services + - serviceTotal + - dailyPickupTotals + - currentPickupTotals + properties: + services: + description: The services used by the shipments and associated details + type: + - array + - "null" + items: + type: + - object + - "null" + required: + - shipmentCount + - itemCount + - totalWeight + - freightChargesAmount + - surchargesAmount + - addedChargesAmount + - billedAmount + - serviceCode + - serviceName + properties: + shipmentCount: + description: number of shipments using this service associated with this manifest + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + itemCount: + description: The total number items in those shipments + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + totalWeight: + description: The Atotal weight of those items + type: number + format: double + minLength: 1 + minimum: 1 + example: 3 + freightChargesAmount: + description: The total charges for this service + $ref: "#/components/schemas/ApolloAmountV1" + surchargesAmount: + description: The total surcharges for this service associated with this manifest + $ref: "#/components/schemas/ApolloAmountV1" + addedChargesAmount: + description: The total added charges for this service associated with this manifest + $ref: "#/components/schemas/ApolloAmountV1" + billedAmount: + description: Total Billed amount for this service + $ref: "#/components/schemas/ApolloAmountV1" + serviceCode: + description: The code for this service + type: + - string + - "null" + minLength: 1 + example: "01" + serviceName: + description: The name of the service + type: + - string + - "null" + minLength: 1 + example: "Next Day Air Early AM" + additionalProperties: false + serviceTotal: + type: object + description: The total for all services + required: + - shipmentCount + - itemCount + - totalWeight + - freightChargesAmount + - surchargesAmount + - addedChargesAmount + - billedAmount + properties: + shipmentCount: + description: The total number of shipments + type: integer + format: int32 + itemCount: + description: The total count of shipments + type: integer + format: int32 + totalWeight: + description: The total weight of shipments + type: number + format: double + freightChargesAmount: + description: total freight charges associated with the shipments in the manifest + type: number + format: double + surchargesAmount: + description: total surcharges associated with the shipments in the manifest + type: number + format: double + addedChargesAmount: + description: total added charges associated with the shipments in the manifest + type: number + format: double + billedAmount: + description: total billed charges associated with the shipments in the manifest + type: number + format: double + additionalProperties: false + dailyPickupTotals: + $ref: "#/components/schemas/ApolloPickupTotalV1" + currentPickupTotals: + $ref: "#/components/schemas/ApolloPickupTotalV1" + additionalProperties: false + additionalProperties: false + manifestNumber: + description: The unique number to identify the manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + manifestFormat: + description: The output format of the manifest + type: + - string + - "null" + minLength: 1 + example: PDF + manifestPDF: + description: The base64 string representing the byte array of the generated PDF + type: + - string + - "null" + format: byte + example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== + additionalProperties: false + ApolloAirShipmentCancelRequestV1: + type: object + required: + - shipperAccountNumber + - shipmentNumber + - language + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + language: + description: The language/culture that is being used for the API + type: string + minLength: 1 + maxLength: 6 + example: en-US + additionalProperties: false + ApolloAirShipmentCancelResponseV1: + type: object + required: + - shipperAccountNumber + - shipmentNumber + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + additionalProperties: false + + #/air/utility/city-details + ApolloGetCityResponseV1: + type: object + required: + - cityDetails + properties: + cityDetails: + description: The unbounded array representing the cities + type: array + minItems: 1 + items: + type: + - object + - "null" + required: + - stateProvinceCode + properties: + stateProvinceCode: + description: The State/Province to which the city belongs to + type: + - string + - "null" + minLength: 1 + example: GA + cityName: + description: The name of the city + type: + - string + - "null" + minLength: 1 + example: Alpharetta + majorAirportCity: + description: The nearest city with a major airport + type: + - string + - "null" + minLength: 1 + example: Atlanta + tariffDestination: + description: The destination used for billing purpose + type: + - string + - "null" + minLength: 1 + example: ATL + sortCode: + description: A value which helps the Ops team to route the package + type: + - string + - "null" + minLength: 1 + example: V1 + standardService: + description: The standard service offered in this city + type: + - string + - "null" + minLength: 1 + example: GND + additionalProperties: false + additionalProperties: false + + #/payment/status + ApolloPaymentPatchV1: + type: array + description: Payload schema for payment record updates + items: + type: object + description: API Request + properties: + op: + type: string + description: Operation type of the Patch + enum: + - add + path: + type: string + description: Resource name + enum: + - /cardAuthStatus + - /paymentGUID + value: + oneOf: + - type: string + description: The status of the card authorization attempt. + oneOf: + - title: Success + const: '20001' + - title: Fail + const: '40001' + - type: string + description: The GUID reference of the payment transaction. This is conditionally required for cardAuthStatus of '20001'. + minLength: 32 + maxLength: 36 + pattern: ^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$ + example: 3437bfbe-fd57-4e50-9802-493b128c63e5 + additionalProperties: false + required: + - op + - path + - value + + #COMMON + ApolloAmountV1: + type: + - number + - "null" + format: double + examples: + - "10.00" + - waived + - included + ApolloChargeV1: + type: object + required: + - code + - amount + - currencyCode + properties: + code: + description: The code used to identify the charge for classification and categorization + type: + - string + - "null" + minLength: 1 + example: AF + description: + description: A short overview of the charge + type: + - string + - "null" + minLength: 1 + example: Air Freight + amount: + type: + - string + - "null" + description: Cost associated with the charge + examples: + - "10.00" + - waived + - included + currencyCode: + description: The ISO 4217 charge currency code + type: + - string + - "null" + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD + includedInd: + type: + - string + - "null" + additionalProperties: false + ApolloCountryCodeV1: + type: string + minLength: 2 + maxLength: 2 + pattern: '^[A-Z]{2}' + example: US + ApolloCustomArrayV1: + type: array + description: Unbounded array of additional key-value pair objects + minItems: 1 + items: + type: object + description: key-value pair object + properties: + key: + type: string + description: the name referencing the paired object + minLength: 1 + example: HAZMAT + value: + type: string + description: the value referencing the paired object + minLength: 1 + example: "true" + additionalProperties: false + ApolloDateV1: + type: string + format: date + example: 2025-05-13 + ApolloDateTimeV1: + type: string + format: date-time + example: 2025-05-13 05:00:00 + ApolloDimensionV1: + type: number + format: float + minimum: 0.1 + maximum: 999.9 + examples: + - 15 + - 6.84 + ApolloErrorResponseV1: + type: object + description: Response object for errors + properties: + response: + type: object + description: Response container to store errors + properties: + errors: + type: array + description: Unbounded array containing one or more error objects + minItems: 1 + items: + type: object + description: Error entity + properties: + code: + type: string + description: error code + minLength: 1 + example: "250002" + message: + type: string + description: error message + minLength: 1 + example: Invalid Authentication Information. + required: + - code + - message + additionalProperties: false + required: + - errors + additionalProperties: false + required: + - response + additionalProperties: false + ApolloItemV1: + type: object + required: + - itemDescription + - count + - length + - width + - height + - weight + properties: + itemDescription: + description: A short description of the item + type: + - string + - "null" + count: + description: A total number of this item + type: + - integer + - "null" + format: int32 + minLength: 1 + minimum: 1 + example: 10 + length: + description: Length of this item + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + width: + description: Width of this item + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + height: + description: Height of this item + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + weight: + description: Total weight of these items + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + additionalProperties: false + ApolloLabelV1: + description: | + An object representing the shipping label. + + | **labelFormat** | **Returned Containers** | + | :--: | :-- | + | DATA | labelFormat, labelData | + | PDF, PNG | labelFormat, labelImage | + type: object + required: + - labelFormat + - shipmentNumber + - orderNumber + - charges + properties: + labelFormat: + description: The output format for the label + type: + - string + - "null" + minLength: 1 + example: PDF + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + charges: + description: A collection of charges associated with this Order. Conditionally required based on payer of charges. + type: object + properties: + shipperCharges: + description: A collection of charges associated with this Order mapped to the shipper + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloChargeV1" + consigneeCharges: + description: A collection of charges associated with this Order mapped to the consignee + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloChargeV1" + thirdPartyCharges: + description: A collection of charges associated with this Order mapped to the third party + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloChargeV1" + additionalProperties: false + labelData: + type: object + required: + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + thirdParty: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + shipment: + type: object + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + description: The service type associated with the Order + type: + - string + - "null" + minLength: 1 + example: AM + paymentType: + description: The payment type associated with the Order + type: + - string + - "null" + minLength: 1 + example: PPD + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The pickup ready time. + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. + format: float + maximum: 999999.99 + minLength: 1 + minimum: 1 + example: 10 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + - LOOSE + orderDescription: + description: A short description of the Order + type: + - string + - "null" + minLength: 1 + example: WIDGETS + shipperReference: + description: A reference to the Order provided by Shipper + type: + - string + - "null" + minLength: 1 + example: ABC123 + consigneeReference: + description: A reference to the Order for the Consignee + type: + - string + - "null" + minLength: 1 + example: Z30010021 + currency: + description: The currency associated with the Order + type: + - string + - "null" + minLength: 3 + maxLength: 3 + example: USD + isMetric: + description: A flag indicating whether the units used are metric + type: + - string + - "null" + items: + description: AA collection of items + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloItemV1" + countryOfManufacture: + description: An unbounded array of country codes where the items originated + type: array + minItems: 1 + items: + type: + - string + - "null" + minLength: 1 + example: US + details: + description: The extra attributes that can be used in a label + $ref: "#/components/schemas/ApolloCustomArrayV1" + rates: + description: The cost associated with the Order to be printed in the label + type: object + properties: + amount: + $ref: "#/components/schemas/ApolloAmountV1" + currencyCode: + type: + - string + - "null" + description: The ISO 4217 currency code + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD + additionalProperties: false + sortCode: + description: The routing value to help the Ops Team + type: + - string + - "null" + minLength: 1 + example: U-BOS + gateway: + description: The airport gateway for routing + type: + - string + - "null" + minLength: 1 + example: "2" + count: + description: The total number of items in the order + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 2 + labelService: + description: The service entry used by the Ops Team + type: + - string + - "null" + minLength: 1 + example: ND + serviceDesc: + description: The description of the service + type: + - string + - "null" + minLength: 1 + example: UPS Next Day Air Freight - NGS + additionalProperties: false + additionalProperties: false + labelImage: + description: The byte array of the generated PDF represented as base64 string + type: + - string + - "null" + format: byte + example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== + additionalProperties: false + ApolloOrderNumberV1: + description: The Unique number used to identify the order + type: string + minLength: 1 + example: "9100010270001" + ApolloPartyV1: + type: object + description: Party information (shipper, consignee, or third party). + required: + - city + - countryCode + properties: + company: + type: string + description: Name of the company. + example: Philip + account: + type: string + description: Account number associated with the party. + example: "987654321" + address1: + type: string + description: Primary address line. + example: 12380 MORRIS RD + address2: + type: string + description: Secondary address line. + example: Mailroom + address3: + type: string + description: Tertiary address line. + example: Floor 1 + city: + type: string + description: City of the party. + example: Alpharetta + state: + type: string + description: The ISO 3166-2 country or territory code. + minLength: 2 + maxLength: 2 + pattern: '^[A-Z]{2}' + example: GA + postalCode: + type: string + description: Postal code of the party. + example: "30005" + countryCode: + description: The ISO 3166 country or territory code. + $ref: "#/components/schemas/ApolloCountryCodeV1" + serviceCenterCode: + type: string + description: Service center code. + examples: + - SDF + - EWR + - ATL + partyCode: + type: string + description: Party code. + example: CID-987654321 + contactName: + type: string + description: Name of the contact person. + example: Michael + contactPhone: + type: string + description: Phone number of the contact person. + example: "999999999" + contactEmail: + type: string + description: Email address of the contact person. + pattern: '^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$' + example: test@gmail.com + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + ApolloPickupTotalV1: + type: object + required: + - shipmentCount + - itemCount + - totalWeight + properties: + shipmentCount: + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 10 + itemCount: + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 10 + totalWeight: + type: number + format: double + minimum: 1 + minLength: 1 + example: 10 + additionalProperties: false + ApolloShipmentNumberV1: + type: + - string + - "null" + description: Unique identifier for the shipment. + minLength: 1 + examples: + - "9100010271" + ApolloShipmentPartyV1: + allOf: + - $ref: "#/components/schemas/ApolloShipmentAddressV1" + - type: object + description: Additional shipment party specific fields. All are optional. + properties: + account: + type: + - string + - "null" + maxLength : 9 + minLength : 6 + description: The unique Account Number associated with the Party + example: 5503YY + serviceCenterCode: + type: + - string + - "null" + maxLength : 5 + description: The service center that is associated with the Party + example: SDF + contactName: + type: + - string + - "null" + maxLength : 40 + description: The name of the person who can handle the communications related to the Shipment + example: John Doe + contactPhone: + type: + - string + - "null" + maxLength : 25 + description: The phone number of the person who can handle the communications related to the Shipment + example: 678-123-4567 + contactEmail: + type: + - string + - "null" + minLength: 1 + maxLength : 40 + description: The email of the person who can handle the communications related to the Shipment + example: john.doe@acme.com + details: + description: Any additional information related to the party in the format of key value pair + $ref: "#/components/schemas/ApolloCustomArrayV1" + unevaluatedProperties: false + ApolloShipmentAddressV1: + type: object + discriminator: + propertyName: operationId + mapping: + orderCreate: '#/components/schemas/ApolloOrderResponseV1' + orderSearch: '#/components/schemas/ApolloOrderSearchResponseV1' + printLabel: '#/components/schemas/ApolloLabelV1' + submitAirShipment: '#/components/schemas/ApolloAirShipmentDataResponseV1' + required: + - address1 + - city + - postalCode + - countryCode + properties: + operationId: + description: A string value to track this operation + type: + - string + - "null" + enum: + - orderCreate + - orderCancel + - orderPostpone + - orderSearch + - printLabel + - submitAirShipment + - cancelAirShipment + - printAirManifest + - airFreightRating + - getCity + partyCode: + type: + - string + - "null" + maxLength : 32 + description: The hashcode generated using the a Party's details, primaririly used to avoid duplicates + example: CID-987654321 + company: + type: + - string + - "null" + maxLength : 40 + description: The name of the company associated with the Shipment/Party + example: Ship To Philip + address1: + type: + - string + - "null" + maxLength : 40 + description: The line 1 of the address associated with the Party + example: 45678 MAIN ST + address2: + type: + - string + - "null" + description: The line 2 of the address associated with the Party + example: Suite 320 + address3: + type: + - string + - "null" + maxLength : 40 + description: The line 3 of the address associated with the Party + example: Floor 3 + city: + type: + - string + - "null" + maxLength : 40 + description: The address city associated with the Party + example: Newark + state: + type: + - string + - "null" + minLength: 2 + maxLength : 4 + pattern: ^[A-Z]{2} + description: The ISO 3166-2 state code associated with the Party + example: NJ + postalCode: + type: + - string + - "null" + maxLength : 15 + description: The line 2 of the address associated with the Party + example: 07102" + countryCode: + type: + - string + - "null" + minLength: 2 + maxLength : 4 + description: The ISO 3166 country or territory code associated with the Party + pattern: ^[A-Z]{2} + example: US + ApolloShipperAccountNumberV1: + description: The Account Number that identifies the Shipper + type: + - string + - "null" + minLength: 1 + example: 4492YY + ApolloTimeV1: + type: string + format: time + pattern: '^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$' + example: 09:00:00 + ApolloWeightV1: + type: number + format: decimal + multipleOf: 0.01 \ No newline at end of file From b1fab680e74c7d95012d7ca2bb8181b9922bc936 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:07:53 -0400 Subject: [PATCH 02/89] Update mainspec1.yaml --- mainspec1.yaml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/mainspec1.yaml b/mainspec1.yaml index 1dcfa1a..91857e2 100644 --- a/mainspec1.yaml +++ b/mainspec1.yaml @@ -36,6 +36,9 @@ tags: - name: Dangerous Goods description: $ref: "DangerousGoods.yaml#/info/description" + - name: Forwarding + description: + $ref: "Forwarding.yaml#/info/description" #- name: Global Checkout # description: # $ref: "GlobalCheckout.yaml#/info/description" @@ -94,6 +97,22 @@ paths: "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/forwarding/{version}/air/rate": + "$ref": "Forwarding.yaml#/paths/~1air~1rate" + "/forwarding/{version}/air/orders": + "$ref": "Forwarding.yaml#/paths/~1air~1orders" + "/forwarding/{version}/air/orders/print-label": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" + "/forwarding/{version}/air/orders/postpone": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" + "/forwarding/{version}/air/orders/search": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" + "/forwarding/{version}/air/shipment": + "$ref": "Forwarding.yaml#/paths/~1air~1shipment" + "/forwarding/{version}/air/utility/city-details": + "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" + "/forwarding/{version}/payment/status/{session_id}": + "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": @@ -224,4 +243,4 @@ components: BasicAuthGenerate: $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' From 5668d7b630146edd9e78850748e1564202cd48db Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:08:36 -0400 Subject: [PATCH 03/89] Update mainspec2.yaml --- mainspec2.yaml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/mainspec2.yaml b/mainspec2.yaml index 0a4cd02..78feeec 100644 --- a/mainspec2.yaml +++ b/mainspec2.yaml @@ -27,6 +27,9 @@ tags: - name: Dangerous Goods description: $ref: "DangerousGoods.yaml#/info/description" + - name: Forwarding + description: + $ref: "Forwarding.yaml#/info/description" #- name: Global Checkout # description: # $ref: "GlobalCheckout.yaml#/info/description" @@ -85,6 +88,22 @@ paths: "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/forwarding/{version}/air/rate": + "$ref": "Forwarding.yaml#/paths/~1air~1rate" + "/forwarding/{version}/air/orders": + "$ref": "Forwarding.yaml#/paths/~1air~1orders" + "/forwarding/{version}/air/orders/print-label": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" + "/forwarding/{version}/air/orders/postpone": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" + "/forwarding/{version}/air/orders/search": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" + "/forwarding/{version}/air/shipment": + "$ref": "Forwarding.yaml#/paths/~1air~1shipment" + "/forwarding/{version}/air/utility/city-details": + "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" + "/forwarding/{version}/payment/status/{session_id}": + "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": @@ -195,4 +214,4 @@ components: BasicAuthGenerate: $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' From 86bd1484b84e52fd65085c1be2880d539e93ed50 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:09:08 -0400 Subject: [PATCH 04/89] Update mainspec3.yaml --- mainspec3.yaml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/mainspec3.yaml b/mainspec3.yaml index e747a11..3ee4f9b 100644 --- a/mainspec3.yaml +++ b/mainspec3.yaml @@ -15,6 +15,9 @@ tags: - name: Dangerous Goods description: $ref: "DangerousGoods.yaml#/info/description" + - name: Forwarding + description: + $ref: "Forwarding.yaml#/info/description" #- name: Global Checkout # description: # $ref: "GlobalCheckout.yaml#/info/description" @@ -73,6 +76,22 @@ paths: "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/forwarding/{version}/air/rate": + "$ref": "Forwarding.yaml#/paths/~1air~1rate" + "/forwarding/{version}/air/orders": + "$ref": "Forwarding.yaml#/paths/~1air~1orders" + "/forwarding/{version}/air/orders/print-label": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" + "/forwarding/{version}/air/orders/postpone": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" + "/forwarding/{version}/air/orders/search": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" + "/forwarding/{version}/air/shipment": + "$ref": "Forwarding.yaml#/paths/~1air~1shipment" + "/forwarding/{version}/air/utility/city-details": + "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" + "/forwarding/{version}/payment/status/{session_id}": + "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": @@ -168,4 +187,4 @@ components: BasicAuthGenerate: $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' From df352386816691ae1ffea960dce4e634937cf05c Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:09:41 -0400 Subject: [PATCH 05/89] Update mainspec4.yaml --- mainspec4.yaml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/mainspec4.yaml b/mainspec4.yaml index 62a7aa2..81ad5bb 100644 --- a/mainspec4.yaml +++ b/mainspec4.yaml @@ -27,6 +27,9 @@ tags: - name: Dangerous Goods description: $ref: "DangerousGoods-Ready.yaml#/info/description" + - name: Forwarding + description: + $ref: "Forwarding.yaml#/info/description" #- name: Global Checkout # description: # $ref: "GlobalCheckout.yaml#/info/description" @@ -82,6 +85,22 @@ paths: "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/forwarding/{version}/air/rate": + "$ref": "Forwarding.yaml#/paths/~1air~1rate" + "/forwarding/{version}/air/orders": + "$ref": "Forwarding.yaml#/paths/~1air~1orders" + "/forwarding/{version}/air/orders/print-label": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" + "/forwarding/{version}/air/orders/postpone": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" + "/forwarding/{version}/air/orders/search": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" + "/forwarding/{version}/air/shipment": + "$ref": "Forwarding.yaml#/paths/~1air~1shipment" + "/forwarding/{version}/air/utility/city-details": + "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" + "/forwarding/{version}/payment/status/{session_id}": + "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": @@ -184,4 +203,4 @@ components: BasicAuthGenerate: $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' BasicAuthRefresh: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' From 6e41ff70282ff164cf9239a7a6fb3ebfea9b24f7 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:10:12 -0400 Subject: [PATCH 06/89] Update mainspec5.yaml --- mainspec5.yaml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/mainspec5.yaml b/mainspec5.yaml index 4b1c8f6..13b5965 100644 --- a/mainspec5.yaml +++ b/mainspec5.yaml @@ -15,6 +15,9 @@ tags: - name: Dangerous Goods description: $ref: "DangerousGoods-Ready.yaml#/info/description" + - name: Forwarding + description: + $ref: "Forwarding.yaml#/info/description" #- name: Global Checkout # description: # $ref: "GlobalCheckout.yaml#/info/description" @@ -70,6 +73,22 @@ paths: "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/forwarding/{version}/air/rate": + "$ref": "Forwarding.yaml#/paths/~1air~1rate" + "/forwarding/{version}/air/orders": + "$ref": "Forwarding.yaml#/paths/~1air~1orders" + "/forwarding/{version}/air/orders/print-label": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" + "/forwarding/{version}/air/orders/postpone": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" + "/forwarding/{version}/air/orders/search": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" + "/forwarding/{version}/air/shipment": + "$ref": "Forwarding.yaml#/paths/~1air~1shipment" + "/forwarding/{version}/air/utility/city-details": + "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" + "/forwarding/{version}/payment/status/{session_id}": + "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": @@ -155,4 +174,4 @@ components: BasicAuthGenerate: $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' BasicAuthRefresh: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' From 48863db7a338dfc7d9ed074f50046cc9eb2b1301 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:10:36 -0400 Subject: [PATCH 07/89] Update mainspec6.yaml --- mainspec6.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/mainspec6.yaml b/mainspec6.yaml index fdad7b9..061e1a7 100644 --- a/mainspec6.yaml +++ b/mainspec6.yaml @@ -33,6 +33,9 @@ tags: - name: Dangerous Goods description: $ref: "DangerousGoods-Ready.yaml#/info/description" + - name: Forwarding + description: + $ref: "Forwarding.yaml#/info/description" #- name: Global Checkout # description: # $ref: "GlobalCheckout.yaml#/info/description" @@ -88,6 +91,22 @@ paths: "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/forwarding/{version}/air/rate": + "$ref": "Forwarding.yaml#/paths/~1air~1rate" + "/forwarding/{version}/air/orders": + "$ref": "Forwarding.yaml#/paths/~1air~1orders" + "/forwarding/{version}/air/orders/print-label": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" + "/forwarding/{version}/air/orders/postpone": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" + "/forwarding/{version}/air/orders/search": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" + "/forwarding/{version}/air/shipment": + "$ref": "Forwarding.yaml#/paths/~1air~1shipment" + "/forwarding/{version}/air/utility/city-details": + "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" + "/forwarding/{version}/payment/status/{session_id}": + "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": From 75223647dd7b220b0c8062844a8a622adc623327 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:11:07 -0400 Subject: [PATCH 08/89] Update mainspec7.yaml --- mainspec7.yaml | 121 ++++++++++++++++++++++++++----------------------- 1 file changed, 65 insertions(+), 56 deletions(-) diff --git a/mainspec7.yaml b/mainspec7.yaml index 35f5e5c..061e1a7 100644 --- a/mainspec7.yaml +++ b/mainspec7.yaml @@ -11,13 +11,13 @@ servers: tags: - name: UPS Track Alert description: - $ref: "UPSTrackAlert.yaml#/info/description" + $ref: "UPSTrackAlert-Ready.yaml#/info/description" - name: UPS Track Alert with Photo description: - $ref: "UPSTrackAlertEnhanced.yaml#/info/description" + $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" - name: Delivery Defense description: - $ref: "DeliveryDefense.yaml#/info/description" + $ref: "DeliveryDefense-Ready.yaml#/info/description" - name: Delivery Intercept description: $ref: "DeliveryIntercept.yaml#/info/description" @@ -29,94 +29,110 @@ tags: $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - name: Address Validation description: - $ref: "AddressValidation.yaml#/info/description" + $ref: "AddressValidation-Ready.yaml#/info/description" - name: Dangerous Goods description: - $ref: "DangerousGoods.yaml#/info/description" + $ref: "DangerousGoods-Ready.yaml#/info/description" + - name: Forwarding + description: + $ref: "Forwarding.yaml#/info/description" #- name: Global Checkout # description: # $ref: "GlobalCheckout.yaml#/info/description" - name: Landed Cost description: - $ref: "LandedCost.yaml#/info/description" + $ref: "LandedCost-Ready.yaml#/info/description" - name: Locator description: $ref: "Locator.yaml#/info/description" - name: OAuth Auth Code description: - $ref: "OAuthAuthCode.yaml#/info/description" + $ref: "OAuthAuthCode-Ready.yaml#/info/description" - name: OAuth Client Credentials description: - $ref: "OAuthClientCredentials.yaml#/info/description" + $ref: "OAuthClientCredentials-Ready.yaml#/info/description" - name: Paperless description: - $ref: "Paperless.yaml#/info/description" + $ref: "Paperless-Ready.yaml#/info/description" - name: Pickup description: $ref: "Pickup.yaml#/info/description" - name: Pre-Notification description: - $ref: "PreNotification.yaml#/info/description" + $ref: "PreNotification-Ready.yaml#/info/description" - name: Quantum View description: - $ref: "QuantumView.yaml#/info/description" + $ref: "QuantumView-Ready.yaml#/info/description" - name: Rating description: $ref: "Rating.yaml#/info/description" - name: Shipping description: $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - name: Time in Transit description: $ref: "TimeInTransit.yaml#/info/description" - name: Tracking description: - $ref: "Tracking.yaml#/info/description" + $ref: "Tracking-Ready.yaml#/info/description" - name: World Ease Shipment Management - Shipment description: $ref: "WorldEaseShipmentManagement.yaml#/info/description" paths: "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "/forwarding/{version}/air/rate": + "$ref": "Forwarding.yaml#/paths/~1air~1rate" + "/forwarding/{version}/air/orders": + "$ref": "Forwarding.yaml#/paths/~1air~1orders" + "/forwarding/{version}/air/orders/print-label": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" + "/forwarding/{version}/air/orders/postpone": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" + "/forwarding/{version}/air/orders/search": + "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" + "/forwarding/{version}/air/shipment": + "$ref": "Forwarding.yaml#/paths/~1air~1shipment" + "/forwarding/{version}/air/utility/city-details": + "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" + "/forwarding/{version}/payment/status/{session_id}": + "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" + "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" + "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" + "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" "/shipments/{version}/pickup/{pickuptype}": "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" "/shipments/{version}/pickup/{CancelBy}": @@ -132,13 +148,13 @@ paths: "/pickupcreation/{deprecatedVersion}/pickup": "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" "/rating/{version}/{requestoption}": "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" "/rating/{deprecatedVersion}/{requestoption}": @@ -153,22 +169,12 @@ paths: "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" "/shipments/{version}/transittimes": "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" "/track/{version}/subscription/enhanced/package": "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" "/deliveryintercept/{version}/charges/{tracking_number}": @@ -186,7 +192,7 @@ paths: "/deliveryintercept/{version}/cancel/{tracking_number}": "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" + "$ref": "DeliveryDefense-Ready.yaml#/paths/~1address~1score" "/brokerage/{version}/importexport/exportassure": "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" "/export-assure/{version}/interactive": @@ -195,6 +201,8 @@ paths: "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" "/export-assure/{version}/interactive/feedback/{sessionId}": "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" + #"/brokerage/{version}/content/glc/request-quote": + # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" "/ship/{version}/master-shipment/closeout/{shipment-gccn}": "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" "/ship/{version}/master-shipment/{shipment-gccn}": @@ -202,19 +210,20 @@ paths: "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" + "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" webhooks: TrackingEvent: - "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" + "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" + "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" components: securitySchemes: OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' + $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' + $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' \ No newline at end of file + + $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' From 8648193e031b8917f03e838773398e8968ee6485 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 9 Sep 2025 11:13:34 -0400 Subject: [PATCH 09/89] Update mainspec7.yaml --- mainspec7.yaml | 102 +++++++++++++++++++++++++++---------------------- 1 file changed, 56 insertions(+), 46 deletions(-) diff --git a/mainspec7.yaml b/mainspec7.yaml index 061e1a7..c319fd9 100644 --- a/mainspec7.yaml +++ b/mainspec7.yaml @@ -11,13 +11,13 @@ servers: tags: - name: UPS Track Alert description: - $ref: "UPSTrackAlert-Ready.yaml#/info/description" + $ref: "UPSTrackAlert.yaml#/info/description" - name: UPS Track Alert with Photo description: - $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" + $ref: "UPSTrackAlertEnhanced.yaml#/info/description" - name: Delivery Defense description: - $ref: "DeliveryDefense-Ready.yaml#/info/description" + $ref: "DeliveryDefense.yaml#/info/description" - name: Delivery Intercept description: $ref: "DeliveryIntercept.yaml#/info/description" @@ -29,10 +29,10 @@ tags: $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - name: Address Validation description: - $ref: "AddressValidation-Ready.yaml#/info/description" + $ref: "AddressValidation.yaml#/info/description" - name: Dangerous Goods description: - $ref: "DangerousGoods-Ready.yaml#/info/description" + $ref: "DangerousGoods.yaml#/info/description" - name: Forwarding description: $ref: "Forwarding.yaml#/info/description" @@ -41,56 +41,59 @@ tags: # $ref: "GlobalCheckout.yaml#/info/description" - name: Landed Cost description: - $ref: "LandedCost-Ready.yaml#/info/description" + $ref: "LandedCost.yaml#/info/description" - name: Locator description: $ref: "Locator.yaml#/info/description" - name: OAuth Auth Code description: - $ref: "OAuthAuthCode-Ready.yaml#/info/description" + $ref: "OAuthAuthCode.yaml#/info/description" - name: OAuth Client Credentials description: - $ref: "OAuthClientCredentials-Ready.yaml#/info/description" + $ref: "OAuthClientCredentials.yaml#/info/description" - name: Paperless description: - $ref: "Paperless-Ready.yaml#/info/description" + $ref: "Paperless.yaml#/info/description" - name: Pickup description: $ref: "Pickup.yaml#/info/description" - name: Pre-Notification description: - $ref: "PreNotification-Ready.yaml#/info/description" + $ref: "PreNotification.yaml#/info/description" - name: Quantum View description: - $ref: "QuantumView-Ready.yaml#/info/description" + $ref: "QuantumView.yaml#/info/description" - name: Rating description: $ref: "Rating.yaml#/info/description" - name: Shipping description: $ref: "Shipping.yaml#/info/description" + - name: TradeDirect + description: + $ref: "TradeDirect.yaml#/info/description" - name: Time in Transit description: $ref: "TimeInTransit.yaml#/info/description" - name: Tracking description: - $ref: "Tracking-Ready.yaml#/info/description" + $ref: "Tracking.yaml#/info/description" - name: World Ease Shipment Management - Shipment description: $ref: "WorldEaseShipmentManagement.yaml#/info/description" paths: "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" + "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" + "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" "/forwarding/{version}/air/rate": "$ref": "Forwarding.yaml#/paths/~1air~1rate" "/forwarding/{version}/air/orders": @@ -108,31 +111,31 @@ paths: "/forwarding/{version}/payment/status/{session_id}": "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" "/landedcost/{version}/quotes": - "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" + "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" "/locations/{version}/search/availabilities/{reqOption}": "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" "/v1/oauth/authorize": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" "/v1/oauth/token": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" "/v1/oauth/refresh": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" + "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" + "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" "/paperlessdocuments/{version}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" "/paperlessdocuments/{version}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" + "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" "/shipments/{version}/pickup/{pickuptype}": "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" "/shipments/{version}/pickup/{CancelBy}": @@ -148,13 +151,13 @@ paths: "/pickupcreation/{deprecatedVersion}/pickup": "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" + "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" "/quantumview/{version}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" + "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" "/rating/{version}/{requestoption}": "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" "/rating/{deprecatedVersion}/{requestoption}": @@ -169,12 +172,22 @@ paths: "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" + "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" + "/ship/tradedirect/{version}/master-shipments/documents": + "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" "/shipments/{version}/transittimes": "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" + "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" + "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" "/track/{version}/subscription/enhanced/package": "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" "/deliveryintercept/{version}/charges/{tracking_number}": @@ -192,7 +205,7 @@ paths: "/deliveryintercept/{version}/cancel/{tracking_number}": "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense-Ready.yaml#/paths/~1address~1score" + "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" "/brokerage/{version}/importexport/exportassure": "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" "/export-assure/{version}/interactive": @@ -201,8 +214,6 @@ paths: "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" "/export-assure/{version}/interactive/feedback/{sessionId}": "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" "/ship/{version}/master-shipment/closeout/{shipment-gccn}": "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" "/ship/{version}/master-shipment/{shipment-gccn}": @@ -210,20 +221,19 @@ paths: "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" + "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" webhooks: TrackingEvent: - "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" + "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" + "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" components: securitySchemes: OAuth2: - $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' + $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' BasicAuth: - $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' + $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' BasicAuthGenerate: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' BasicAuthRefresh: - - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' + $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' From 49a3cea0636aeca2f8f4e5323deda45b57cb17e7 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Thu, 11 Sep 2025 09:10:14 -0400 Subject: [PATCH 10/89] Update Tracking.yaml --- Tracking.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Tracking.yaml b/Tracking.yaml index b67fb87..1b3b35f 100644 --- a/Tracking.yaml +++ b/Tracking.yaml @@ -18,6 +18,7 @@ info: - Business Rules - Appendix - Errors + - Tracking Best Practices - Accelerate API Integration with UPS MCP Server

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Date: Wed, 17 Sep 2025 09:59:44 -0400 Subject: [PATCH 11/89] Update UPSTrackAlert.yaml --- UPSTrackAlert.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/UPSTrackAlert.yaml b/UPSTrackAlert.yaml index 11898fc..fadf07f 100644 --- a/UPSTrackAlert.yaml +++ b/UPSTrackAlert.yaml @@ -27,6 +27,7 @@ info: # Reference - Appendix + - Track Alert Best Practices # FAQs @@ -726,3 +727,4 @@ components: description: type: string description: The current activity status description. + From 3aa2d0673182b108b203ddf31044f0aa8268ca66 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 17 Sep 2025 10:00:05 -0400 Subject: [PATCH 12/89] Update UPSTrackAlert-Ready.yaml --- UPSTrackAlert-Ready.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/UPSTrackAlert-Ready.yaml b/UPSTrackAlert-Ready.yaml index 7d1ee19..fdc31c8 100644 --- a/UPSTrackAlert-Ready.yaml +++ b/UPSTrackAlert-Ready.yaml @@ -36,6 +36,7 @@ info: # Reference - Appendix + - Track Alert Best Practices # FAQs @@ -728,3 +729,4 @@ components: description: type: string description: The current activity status description. + From cdf1ba38d3a126ac21d8c3986cee97f7999fc3dd Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 17 Sep 2025 10:00:20 -0400 Subject: [PATCH 13/89] Update UPSTrackAlertEnhanced-Ready.yaml --- UPSTrackAlertEnhanced-Ready.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/UPSTrackAlertEnhanced-Ready.yaml b/UPSTrackAlertEnhanced-Ready.yaml index 395f292..08cbf0f 100644 --- a/UPSTrackAlertEnhanced-Ready.yaml +++ b/UPSTrackAlertEnhanced-Ready.yaml @@ -36,6 +36,7 @@ info: # Reference - Appendix + - Track Alert Best Practices # FAQs @@ -775,3 +776,4 @@ components: description: type: string description: The current activity status description. + From af268a9c95f32c12b74f31f8b300468dd4a673f0 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 17 Sep 2025 10:00:39 -0400 Subject: [PATCH 14/89] Update UPSTrackAlertEnhanced.yaml --- UPSTrackAlertEnhanced.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/UPSTrackAlertEnhanced.yaml b/UPSTrackAlertEnhanced.yaml index 6bbc485..01b23fc 100644 --- a/UPSTrackAlertEnhanced.yaml +++ b/UPSTrackAlertEnhanced.yaml @@ -27,6 +27,7 @@ info: # Reference - Appendix + - Track Alert Best Practices # FAQs @@ -774,3 +775,4 @@ components: description: type: string description: The current activity status description. + From cbafc2d3d7e867a8b3b5b67586c332c57fac3f36 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 5 Nov 2025 13:01:58 -0500 Subject: [PATCH 15/89] Update --- Shipping.yaml | 90 +++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 70 insertions(+), 20 deletions(-) diff --git a/Shipping.yaml b/Shipping.yaml index d7e19e2..abd11b7 100644 --- a/Shipping.yaml +++ b/Shipping.yaml @@ -4975,6 +4975,22 @@ components: type: string minLength: 2 maxLength: 2 + ShipperType: + description: |- + Shipment Value for ShipperType. 01 = Business 02 = Consumer/Individual NA = Not Applicable + Required for EU Inbound Shipments + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ConsigneeType: + description: |- + Shipment Value for ConsigneeType. 01 = Business 02 = Consumer/Individual NA = Not Applicable + Required for EU Inbound Shipments + maximum: 1 + type: string + minLength: 2 + maxLength: 2 MasterCartonID: description: 'Master Carton ID. If Economy Service (17 or 72) : Economy Shipment will be associated with given Master Carton ID. If Non-Economy @@ -5668,7 +5684,7 @@ components: - 1051 = Singapore GST Registration Number - 1052 = ARN Registration Number - 1053 = IRD Registration Number - - 1054 = Malaysia Low Value Goods Sales Tax Registration + - 1054 = Malaysia Low Value Goods Sales Tax Registration Number Vendor Collect ID Number type code will be printed on commercial invoice if present. maximum: 1 @@ -5790,13 +5806,13 @@ components: type: string minLength: 2 maxLength: 2 - xml: + xml: name: BillShipper description: Container for the BillShipper billing option. The three payment methods that are available for the Bill Shipper billing option are alternate payment method, account number or credit card. This element or its sibling element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator, must be - present but no more than one can be present. + present but no more than one can be present. BillShipper_CreditCard: type: object maximum: 1 @@ -7236,7 +7252,8 @@ components: type: string xml: name: InternationalForms - description: International Forms information. + description: International Forms information. This is applicable to Trade Direct SMALLPACKAGE International Child + movements and not applicable to Trade Direct Master or Trade Direct LTL Child movements. InternationalForms_UserCreatedForm: type: object maximum: 13 @@ -7430,11 +7447,21 @@ components: type: string minLength: 40 maxLength: 40 + DDSReferenceNumber: + "$ref": "#/components/schemas/CN22Content_CN22DDSReferenceNumber" xml: name: CN22Content description: "Container for CN22 content. Required if the CN22 form container is present. \nNote: The maximum number of goods printed on the CN22 form when a combined MI package and CN22 form label is requested is 30." + CN22Content_CN22DDSReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: holds a list of DDS Reference Numbers + maximum: 5 + type: string CN22Content_CN22ContentWeight: type: object required: @@ -8268,6 +8295,8 @@ components: "$ref": "#/components/schemas/Product_PackingListInfo" EEIInformation: "$ref": "#/components/schemas/Product_EEIInformation" + DDSReferenceNumber: + "$ref": "#/components/schemas/Product_DDSReferenceNumber" xml: name: Product description: "Contains the commodity/product information. Applies to EEI, Invoice, @@ -8534,6 +8563,14 @@ components: description: |- Data Container holding package/product related information that will break up the product into each package on the packing list. Total product amount must equal the product unit value above. Required for packaging list and Air Freight Packing list. Packaging list max allowed : 20 Air Freight Packaging list max allowed: 200 + Product_DDSReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: holds a list of DDS Reference Numbers + maximum: 5 + type: string Product_EEIInformation: type: object maximum: 1 @@ -9107,8 +9144,8 @@ components: name: Package required: - Packaging - description: Package Information container. For Return Shipments up to and - including 20 packages are allowed. US/PR origin return movements are limited + description: Package Information container. For Return Shipments up to + 20 packages are allowed. US/PR origin return movements are limited to only one package. For Mail Innovations and Simple Rate shipments only one package is allowed. Shipment_TradeDirect: @@ -9123,7 +9160,7 @@ components: $ref: '#/components/schemas/TradeDirect_Child' GeneralDescriptionOfGoods: description: General description of the goods being shipped. It is required for master shipment. - pattern: ^[a-zA-Z0-9 ]{1,100}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]+$ type: string ShipmentType: description: | @@ -9143,7 +9180,7 @@ components: CurrencyCode: description: The currency code for the shipment as per ISO 4217. type: string - pattern: ^[A-Z]{3}$ + pattern: ^(?!\s*$)[A-Z]{3}$ xml: name: TradeDirect maximum: 1 @@ -9196,12 +9233,14 @@ components: type: string minLength: 1 maxLength: 35 + pattern: ^(?!\s*$).{1,35}$ AttentionName: description: Master Sold to Contact Name. maximum: 1 type: string minLength: 1 maxLength: 35 + pattern: ^.{0,35}$ TaxIdentificationNumber: deprecated: true description: Master Sold To Tax Identification Number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container. @@ -9248,12 +9287,14 @@ components: type: string minLength: 1 maxLength: 35 + pattern: ^(?!\s*$).{1,35}$ AttentionName: description: Master Pickup Contact Name. maximum: 1 type: string minLength: 1 maxLength: 35 + pattern: ^.{0,35}$ Phone: $ref: '#/components/schemas/TradeDirect_Phone' Address: @@ -9297,12 +9338,12 @@ components: description: Primary address line includes street number and street name (when applicable). maximum: 3 type: string - pattern: ^[A-Za-z0-9\s.,#/-]{1,35}$ + pattern: ^(?!\s*$).{1,35}$ example: 123 South Main St City: description: The name of the city for the address. type: string - pattern: ^[a-zA-Z\s.,]{1,35}$ + pattern: ^(?!\s*$).{1,35}$ example: Atlanta StateProvinceCode: description: The code for the state or province for the address. @@ -9425,7 +9466,7 @@ components: Description: description: Description of the product being shipped. type: string - pattern: ^[a-zA-Z0-9 ]{1,100}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,100}$ example: ALPHA BRAIN INSTANT PEACH UnitPrice: description: Price per unit of the product being shipped. @@ -9441,7 +9482,7 @@ components: description: Product number of the product being shipped. type: string example: IDID767640 - pattern: ^[a-zA-Z0-9 ]{1,20}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,20}$ CountryOriginCode: description: Country code of the product being shipped. type: string @@ -9714,7 +9755,7 @@ components: description: 'Description of what the other charges are for.' type: string example: Miscellaneous charge - pattern: ^[a-zA-Z0-9 ]{1,30}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,30}$ xml: name: OtherCharges description: 'Any other miscellaneous charges.' @@ -10694,8 +10735,9 @@ components: RegulationSet: description: 'Regulation set for dryIce Shipment. Valid values: CFR = HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments - to Canada, IATA= Worldwide Air movement. The following values are valid: - IATA, CFR.' + to Canada, IATA= Worldwide Air movement, ADR = Europe to + Europe Ground Movement. The following values are valid: + IATA, CFR, ADR.' maximum: 1 type: string minLength: 3 @@ -13822,11 +13864,16 @@ components: maximum: 1 properties: AgentRole: - description: '(SHIP_FROM=20, CONSIGNEE=30)' + description: 'When the value passed to the AgentRole parameter is 30, + the value passed to the IDNumberTypeCode parameter must be 1002, 1005 or 0005. + (SHIP_FROM=20, CONSIGNEE=30)' type: string TaxIdentificationNumber: - $ref: >- - #/components/schemas/AgentTaxIdentificationNumber_TaxIdentificationNumber + items: + $ref: >- + #/components/schemas/AgentTaxIdentificationNumber_TaxIdentificationNumber + maximum: 8 + type: array required: - AgentRole type: object @@ -13985,8 +14032,11 @@ components: minLength: 2 maxLength: 2 AgentTaxIdentificationNumber: - $ref: >- - #/components/schemas/GlobalTaxInformation_AgentTaxIdentificationNumber + type: array + items: + $ref: >- + #/components/schemas/GlobalTaxInformation_AgentTaxIdentificationNumber + maximum: 4 type: object xml: name: GlobalTaxInformation From 2f9d096db74aa5b3f3a4833a794081a26675de93 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Thu, 6 Nov 2025 11:26:16 -0500 Subject: [PATCH 16/89] Ship api update (#192) update --- Paperless.yaml | 2 +- Shipping.yaml | 106 ++++++++++++++++++++++++------------------------- 2 files changed, 54 insertions(+), 54 deletions(-) diff --git a/Paperless.yaml b/Paperless.yaml index 058834c..1acfad3 100644 --- a/Paperless.yaml +++ b/Paperless.yaml @@ -1067,7 +1067,7 @@ components: description: The type of documents in UserCreatedForm file. The allowed document types are 001 - Authorization Form, 002 - Commercial Invoice, 003 - Certificate of Origin, 004 - Export Accompanying Document, 005 - - Export License, 006 - Import Permit, 007 - One Time NAFTA, 008 - Other + Export License, 006 - Import Permit, 007 - One Time USMCA, 008 - Other Document, 009 - Power of Attorney, 010 - Packing List, 011 - SED Document, 012 - Shipper's Letter of Instruction, 013 - Declaration. The total number of documents allowed per file or per shipment is 13. Each document type diff --git a/Shipping.yaml b/Shipping.yaml index abd11b7..b0d24d9 100644 --- a/Shipping.yaml +++ b/Shipping.yaml @@ -313,7 +313,7 @@ paths: ShipmentServiceOptions: InternationalForms: FormType: '04' - FormGroupIdName: NAFTA Form + FormGroupIdName: USMCA Form Contacts: SoldTo: Option: " " @@ -2863,7 +2863,7 @@ paths: ShipmentServiceOptions: InternationalForms: FormType: '04' - FormGroupIdName: NAFTA Form + FormGroupIdName: USMCA Form Contacts: SoldTo: Option: " " @@ -6967,7 +6967,7 @@ components: Valid values: - 01 - Invoice - 03 - CO - - 04 - NAFTA CO + - 04 - USMCA - 05 - Partial Invoice - 06 - Packinglist - 07 - Customer Generated Forms @@ -6993,9 +6993,9 @@ components: "$ref": "#/components/schemas/InternationalForms_CN22Form" AdditionalDocumentIndicator: description: "Presence of the indicator means user will supply additional - document, such as EEI, NAFTA_CO or CO. This indicator should be set when + document, such as EEI, USMCA or CO. This indicator should be set when the shipper intends to utilize UPS paperless invoice functionality AND - the shipper has SELF-PREPARED other International Forms (EEI, CO, NAFTACO) + the shipper has SELF-PREPARED other International Forms (EEI, CO, USMCA) to accompany the shipment. \nIt is evaluated only when: \n1. Account is paperless enabled. \n2. Movement requires an invoice.\n3. Destination country or territory accepts paperless invoice. \n4. Invoice data is supplied @@ -7077,7 +7077,7 @@ components: used by Customs. Examples of declarations that might be entered in this field are: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff treatment under - the NAFTA. I hereby certify that the information on this invoice is true + the USMCA. I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above. EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA @@ -7233,7 +7233,7 @@ components: type: string OverridePaperlessIndicator: description: The application will automatically provide a copy of the invoice - or NAFTA/CO with each response regardless of whether the user has enabled + or USMCA with each response regardless of whether the user has enabled Paperless account. The user now has the option to print or ignore the copy provided. maximum: 1 @@ -7637,9 +7637,9 @@ components: xml: name: Contacts description: Holds the contact information of various parties. Applicable for - EEI and NAFTA CO only. Required for NAFTA CO and EEI. Ultimate consignee contact + EEI and USMCA only. Required for USMCA and EEI. Ultimate consignee contact information is required for EEI. Producer contact information is required - for NAFTA CO + for USMCA maximum: 1 Contacts_ForwardAgent: type: object @@ -7901,7 +7901,7 @@ components: list of additional producers, including the legal name, address (including country or territory), and legal tax identification number, cross-referenced to the goods described in the Description of Goods field. Applies to - NAFTA CO. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02 + USMCA. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02 - SAME AS EXPORTER\n03 - ATTACHED LIST\n04 - UNKNOWN" maximum: 1 type: string @@ -7909,14 +7909,14 @@ components: maxLength: 2 CompanyName: description: 'Company Name or the Individual name of the Producer. Applies - to NAFTA CO. Only applicable when producer option is empty or not present. - Conditionally required for: NAFTA CO, when Producer option is not specified.' + to USMCA. Only applicable when producer option is empty or not present. + Conditionally required for: USMCA, when Producer option is not specified.' maximum: 1 type: string minLength: 1 maxLength: 35 TaxIdentificationNumber: - description: Tax ID of the Producer. Applies to NAFTA CO. Only applicable + description: Tax ID of the Producer. Applies to USMCA. Only applicable when producer option is empty or not present maximum: 1 type: string @@ -7925,7 +7925,7 @@ components: Address: "$ref": "#/components/schemas/Producer_Address" AttentionName: - description: Contact name at the Producer location. Applies to NAFTA CO. + description: Contact name at the Producer location. Applies to USMCA. maximum: 1 type: string minLength: 1 @@ -7933,18 +7933,18 @@ components: Phone: "$ref": "#/components/schemas/Producer_Phone" EMailAddress: - description: Producer email address. Applies to NAFTA CO. + description: Producer email address. Applies to USMCA. maximum: 1 type: string minLength: 1 maxLength: 50 xml: name: Producer - description: "Information of the producer. The NAFTA Certificate of Origin must + description: "Information of the producer. The USMCA Certificate of Origin must be completed, signed, and dated by the exporter. \nWhen the Certificate is completed by the producer for use by the exporter, it must be completed, signed, and dated by the producer. The date must be the date the Certificate was completed - and signed. Applies to NAFTA CO. Required for NAFTA CO forms." + and signed. Applies to USMCA. Required for USMCA forms." Producer_Address: type: object maximum: 1 @@ -7962,13 +7962,13 @@ components: minLength: 1 maxLength: 35 City: - description: "City of the Producer. Applies to NAFTA CO. Conditionally required for: NAFTA CO, when Producer option is not specified." + description: "City of the Producer. Applies to USMCA. Conditionally required for: USMCA, when Producer option is not specified." maximum: 1 type: string minLength: 1 maxLength: 30 StateProvinceCode: - description: State of the Producer. Applies to NAFTA CO. Required for certain countries or territories. + description: State of the Producer. Applies to USMCA. Required for certain countries or territories. maximum: 1 type: string minLength: 1 @@ -7980,22 +7980,22 @@ components: minLength: 1 maxLength: 30 PostalCode: - description: Postal code of the Producer. Applies to NAFTA CO. Required for certain countries or territories. The length of the postal code depends on the country or territory code. + description: Postal code of the Producer. Applies to USMCA. Required for certain countries or territories. The length of the postal code depends on the country or territory code. maximum: 1 type: string minLength: 1 maxLength: 9 CountryCode: - description: Country or Territory code of the Producer. Applies to NAFTA CO. + description: Country or Territory code of the Producer. Applies to USMCA. maximum: 1 type: string minLength: 2 maxLength: 2 xml: name: Address - description: 'Address information of the Producer. Applies to NAFTA CO. Only + description: 'Address information of the Producer. Applies to USMCA. Only applicable if producer option is empty or not present. Conditionally required - for: NAFTA CO, when Producer option is not specified.' + for: USMCA, when Producer option is not specified.' Producer_Phone: type: object maximum: 1 @@ -8003,20 +8003,20 @@ components: - Number properties: Number: - description: The locations phone number of the Producer. Applies to NAFTA CO. + description: The locations phone number of the Producer. Applies to USMCA. maximum: 1 type: string minLength: 1 maxLength: 15 Extension: - description: The locations phone extension of the Producer. Applies to NAFTA CO. + description: The locations phone extension of the Producer. Applies to USMCA. maximum: 1 type: string minLength: 1 maxLength: 4 xml: name: Phone - description: Phone number information of Producer. Applies to NAFTA CO. + description: Phone number information of Producer. Applies to USMCA. Contacts_SoldTo: type: object maximum: 1 @@ -8047,7 +8047,7 @@ components: Phone: "$ref": "#/components/schemas/SoldTo_Phone" Option: - description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02." + description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02." maximum: 1 type: string minLength: 2 @@ -8070,8 +8070,8 @@ components: name: SoldTo description: SoldTo Container. The Sold To party's country code must be the same as the Ship To party's country code with the exception of Canada and - satellite countries. Applies to Invoice and NAFTA CO Forms. Required if Invoice - or NAFTA CO (International Form) is requested. + satellite countries. Applies to Invoice and USMCA Forms. Required if Invoice + or USMCA (International Form) is requested. SoldTo_Phone: type: object maximum: 1 @@ -8102,7 +8102,7 @@ components: - CountryCode properties: AddressLine: - description: SoldTo location's street address. Applies to NAFTA CO. + description: SoldTo location's street address. Applies to USMCA. maximum: 3 type: array items: @@ -8141,7 +8141,7 @@ components: maxLength: 2 xml: name: Address - description: Sold To Address Container. Applies to NAFTA CO. + description: Sold To Address Container. Applies to USMCA. InternationalForms_Product: type: object maximum: 1 @@ -8163,8 +8163,8 @@ components: CommodityCode: description: '6-to-15-alphanumeric commodity code. Customs uses this code to determine what duties should be assessed on the commodity. Applies - to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional - for Partial Invoice. Should be at least 6 alphanumeric. For NAFTA CO: + to Invoice, Partial Invoice and USMCA. Required for USMCA and optional + for Partial Invoice. Should be at least 6 alphanumeric. For USMCA: For each good described in Description of Goods field, identify the H.S. tariff classification to six digits. If the good is subject to a specific rule of origin in Annex 401 that requires eight digits, identify to eight @@ -8195,13 +8195,13 @@ components: maxLength: 2 JointProductionIndicator: description: If present, JNT will be used as the origin of country or territory - code on the NAFTA form and the Product/Origincountry or territoryCode - tag will be ignored. Applies to NAFTA CO only. + code on the USMCA form and the Product/Origincountry or territoryCode + tag will be ignored. Applies to USMCA only. maximum: 1 type: string NetCostCode: description: | - For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to NAFTA CO only. Required for NAFTA CO. Valid values: + For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values: - NC - ND - NO @@ -8217,7 +8217,7 @@ components: are contained in Chapter Four and Annex 401. \n\nAdditional rules are described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix 6 (certain textile goods) and Annex 308.1 (certain automatic data processing - goods and their parts). Applies to NAFTA CO only." + goods and their parts). Applies to USMCA only." maximum: 1 type: string minLength: 1 @@ -8229,7 +8229,7 @@ components: an originating good. \nNo [2] - Reliance on the producers written representation (other than a Certificate of Origin) that the good qualifies as an originating good. \nNo [3] - A completed and signed Certificate for the good voluntarily - provided to the exporter by the producer. Applicable for NAFTA CO and + provided to the exporter by the producer. Applicable for USMCA and is required. Valid values: Yes, No [1], No [2], and No [3]." maximum: 1 type: string @@ -8300,10 +8300,10 @@ components: xml: name: Product description: "Contains the commodity/product information. Applies to EEI, Invoice, - Partial Invoice, CO and NAFTA CO. When any International form is requested, + Partial Invoice, CO and USMCA. When any International form is requested, at least one Product must be present. \n\nMaximum number of products allowed for different forms are:\n\n50: Package Packing List\n\n100: Commercial Invoice, - NAFTA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice + USMCA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice this container is optional." Product_Unit: type: object @@ -8378,7 +8378,7 @@ components: BeginDate: description: 'If the RVC is calculated over a period of time, it should be identified by the begin date (yyyyMMdd) of that period. (Reference: - Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.' + Articles 402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.' maximum: 1 type: string minLength: 8 @@ -8386,14 +8386,14 @@ components: EndDate: description: 'If the RVC is calculated over a period of time, it should be identified by the End date (yyyyMMdd) of that period. (Reference: Articles - 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.' + 402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.' maximum: 1 type: string minLength: 8 maxLength: 8 xml: name: NetCostDateRange - description: Date Range for regional value content (RVC). Applies to NAFTA + description: Date Range for regional value content (RVC). Applies to USMCA CO only. Product_ProductWeight: type: object @@ -8510,7 +8510,7 @@ components: - FormType properties: FormType: - description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – NAFTA CO. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED. + description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – USMCA. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED. type: array items: type: string @@ -8812,7 +8812,7 @@ components: description: Begin date of the blanket period. It is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). Applies - to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This + to USMCA form only. Required for USMCA. Format is yyyyMMdd. This is not valid for a paperless shipment. maximum: 1 type: string @@ -8820,7 +8820,7 @@ components: maxLength: 8 EndDate: description: End Date of the blanket period. It is the date upon which the - blanket period expires. Applies to NAFTA CO form only. Required for NAFTA + blanket period expires. Applies to USMCA form only. Required for USMCA CO. Format is yyyyMMdd. This is not valid for a paperless shipment. maximum: 1 type: string @@ -8828,12 +8828,12 @@ components: maxLength: 8 xml: name: BlanketPeriod - description: This field should be entered if the NAFTA Certificate covers multiple + description: This field should be entered if the USMCA Certificate covers multiple shipments of identical goods as described in the Description of Goods field - that are imported into a NAFTA country or territory for a specified period + that are imported into a USMCA country or territory for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between - these dates. Applies to NAFTA CO form only. Required for NAFTA CO. This + these dates. Applies to USMCA form only. Required for USMCA. This is not valid for a paperless shipment. ShipmentServiceOptions_DeliveryConfirmation: type: object @@ -9251,7 +9251,7 @@ components: Phone: $ref: '#/components/schemas/TradeDirect_Phone' Option: - description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02." + description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02." maximum: 1 type: string minLength: 2 @@ -9402,15 +9402,15 @@ components: maxLength: 150 DeclarationStatement: description: | - The type of declaration statement. Can be invoice or NAFTA. + The type of declaration statement. Can be invoice or USMCA. Valid values: - Invoice = Invoice declaration - - NAFTA = NAFTA declaration + - USMCA = USMCA declaration type: string - enum: ["Invoice", "NAFTA"] + enum: ["Invoice", "USMCA"] xml: name: TradeComplianceDetails description: 'Contains trade compliance details for the master shipment, such as invoice terms, export reasons, and declaration statements. It also includes additional comments or instructions for customs clearance.' From f56489d3bf8790fc1a72f5ccf621c20aff34c40f Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 7 Nov 2025 14:40:24 -0500 Subject: [PATCH 17/89] Update --- Forwarding.yaml | 6344 ++++++++++++++++++++++++++++++----------------- 1 file changed, 4039 insertions(+), 2305 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index e9103e0..bfa24b0 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -33,23 +33,25 @@ servers: tags: - name: Orders description: Endpoints related to shipments not yet submitted for processing - - name: Rate - description: Endpoints related to Rating - - name: Ship + - name: Shipments description: Endpoints related to shipments in process - name: Info description: Endpoints related to Information - - name: Payment - description: Endpoints related to Payments + - name: Documents + description: Endpoints related to document generation + + + security: - oauth2: [] paths: - /air/rate: + /shipments/rates: post: - description: Generate Air Freight rates based on the provided shipment, Shipper/Consignee/Payor, and Cargo details. - operationId: Air Freight Rating + summary: Get Freight Rates + description: Generate estimated freight charges based on the provided origin, destination, payor information, and cargo details. + operationId: freightRating tags: - - Forwarding + - Shipments parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -65,7 +67,7 @@ paths: example: shipper: company: Philip - account: "987654321" + account: "123456789" address1: 12380 MORRIS RD city: SHREWSBURY state: NJ @@ -81,14 +83,14 @@ paths: value: SN654321 consignee: company: Ship To Philip - account: 442Y - address1: 45678 MAIN ST - city: NEWARK + account: "123456789" + address1: 12380 MORRIS RD + city: SHREWSBURY state: NJ postalCode: "07102" countryCode: US - serviceCenterCode: EWR - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + serviceCenterCode: SDF + partyCode: CID987654321 contactName: Sarah contactPhone: "888888888" contactEmail: sarah@example.com @@ -189,12 +191,9 @@ paths: guaranteedDelivery: true deliveryTime: "2025-05-14 12:00:00" holdAtAirportTime: "2025-05-14 17:00:00" - totalCharge: - code: AF - description: Air Freight + totalCharge: amount: "1170.71" currencyCode: USD - currencyCode: USD billableWeight: 151 weightUnit: LBS dimensionalWeight: 47 @@ -237,7 +236,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -265,7 +264,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "500": description: Server Error @@ -293,12 +292,13 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error - /air/orders: + /orders: post: - operationId: Create Order - description: Cretae a pending order which becomes a shipment when processed at end-of-day + summary: Create a order + operationId: orderCreate + description: Create a pending order which becomes a shipment when processed at end-of-day parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -306,7 +306,7 @@ paths: - $ref: "#/components/parameters/X-BusinessGUID" - $ref: "#/components/parameters/X-ClientId" tags: - - Forwarding + - Orders requestBody: required: true description: Container for shipment & package details to be made into an order. @@ -316,7 +316,7 @@ paths: $ref: "#/components/schemas/ApolloOrderRequestV1" example: shipper: - account: 4492YY + account: "123456789" serviceCenterCode: SDF contactName: Zeus contactPhone: "8888888888" @@ -335,7 +335,7 @@ paths: postalCode: "40214" countryCode: US consignee: - account: 5503YY + account: "123456789" serviceCenterCode: BOS partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 contactName: Sheldon @@ -386,32 +386,18 @@ paths: currency: USD isMetric: false items: - - - - key: itemDescription - value: White Leather Men's Sneakers - - key: count - value: "1" - - key: length - value: "10" - - key: width - value: "18" - - key: height - value: "10" - - key: weight - value: "26" - - - - key: itemDescription - value: Green floral midi female dress. - - key: count - value: "1" - - key: length - value: "10" - - key: width - value: "18" - - key: height - value: "10" - - key: weight - value: "26" + - itemDescription: White Leather Men's Sneakers + count: 1 + length: 10 + width: 18 + height: 10 + weight: 26 + - itemDescription: Green floral midi female dress. + count: 1 + length: 10 + width: 18 + height: 10 + weight: 26 countryOfManufacture: - US - MX @@ -479,104 +465,109 @@ paths: schema: $ref: "#/components/schemas/ApolloOrderResponseV1" example: - shipmentNumber: "9100010271" - orderNumber: "9100010270001" - labelFormat: DATA - charges: - shipperCharges: - - code: AF - description: Air Freight - amount: "10.00" - currencyCode: USD - consigneeCharges: - - code: DL - description: Delivery Charges - amount: "10.00" - currencyCode: USD - labelData: - shipper: - company: ABC Inc - address1: 123 Som St - city: Atlanta - state: GA - postalCode: "30005" - countryCode: US - account: 1420YY - serviceCenterCode: ATL - contactName: Zeus - contactPhone: "8888888888" - contactEmail: test1@ups.com - consignee: - company: ABC Inc - address1: 123 Som St - city: Atlanta - state: GA - postalCode: "30005" - countryCode: US - account: 1420YY - serviceCenterCode: ATL - contactName: Zeus - contactPhone: "8888888888" - contactEmail: test1@ups.com - shipment: - shipmentNumber: "9100010271" - serviceType: AM - paymentType: PPD - pickupDate: 2025-10-22 - readyTime: 11:00:00 - closeTime: 17:00:00 - dropoffTime: 11:10:00 - weight: 54 - freightType: PALLET - orderDescription: Apparels - shipperReference: Z30010021 - consigneeReference: ABC123 - currency: USD - isMetric: "0" - countryOfManufacture: - - US - - MX - - CA - - GB - details: - - key: HAZMAT - value: "false" - - key: HAPU - value: "true" - - key: SAT - value: "false" - - key: CC - value: "false" - - key: CV - value: "0" - - key: CV-Currency - value: "USD" - - key: DV - value: "1000" - - key: DV-Currency - value: "USD" - - key: PICKUP - value: "true" - - key: DDU - value: "false" - - key: DDP - value: "false" - - key: RESPU - value: "true" - - key: RESDLV - value: "true" - - key: LIFTGTPU - value: "true" - - key: LIFTGTDLV - value: "true" - rates: - amount: 1526.74 - currencyCode: USD - sortCode: U-BOS - gateway: ATL - count: 2 - labelService: ND - serviceDesc: UPS Next Day Air Freight - NGS + response: + shipmentNumber: "9100010271" + orderNumber: "9100010270001" + labelFormat: DATA + charges: + shipperCharges: + - code: AF + description: Air Freight + amount: "10.00" + currencyCode: USD + consigneeCharges: + - code: DL + description: Delivery Charges + amount: "10.00" + currencyCode: USD + labelData: + shipper: + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" + countryCode: US + account: "123456789" + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + consignee: + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" + countryCode: US + account: "123456789" + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + shipment: + shipmentNumber: "9100010271" + serviceType: AM + paymentType: PPD + pickupDate: 2025-10-22 + readyTime: 11:00:00 + closeTime: 17:00:00 + dropoffTime: 11:10:00 + weight: 54 + freightType: PALLET + orderDescription: Apparels + shipperReference: Z30010021 + consigneeReference: ABC123 + currency: USD + isMetric: "0" + countryOfManufacture: + - US + - MX + - CA + - GB + details: + - key: HAZMAT + value: "false" + - key: HAPU + value: "true" + - key: SAT + value: "false" + - key: CC + value: "false" + - key: CV + value: "0" + - key: CV-Currency + value: "USD" + - key: DV + value: "1000" + - key: DV-Currency + value: "USD" + - key: PICKUP + value: "true" + - key: DDU + value: "false" + - key: DDP + value: "false" + - key: RESPU + value: "true" + - key: RESDLV + value: "true" + - key: LIFTGTPU + value: "true" + - key: LIFTGTDLV + value: "true" + rates: + amount: 1526.74 + currencyCode: USD + sortCode: U-BOS + gateway: ATL + count: 2 + labelService: ND + serviceDesc: UPS Next Day Air Freight - NGS + warnings: + - code: "1050" + message: Consignee Contact Name too long + "400": description: Bad Request headers: @@ -662,9 +653,10 @@ paths: - code: "1003" message: Internal Server Error delete: - operationId: Cancel Order + summary: Cancel an order + operationId: orderCancel tags: - - Forwarding + - Orders description: Cancel an pending order parameters: - $ref: "#/components/parameters/transId" @@ -680,7 +672,7 @@ paths: schema: $ref: "#/components/schemas/ApolloCancelOrderRequestV1" example: - account: 4492YY + account: "123456789" orderNumber: "3912088430001" language: en-US responses: @@ -704,8 +696,9 @@ paths: schema: $ref: "#/components/schemas/ApolloCancelOrderResponseV1" example: - shipmentNumber: "9100010271" - orderNumber: "9100010270001" + response: + shipmentNumber: "9100010271" + orderNumber: "9100010270001" "400": description: Bad Request headers: @@ -818,30 +811,58 @@ paths: errors: - code: "1003" message: Internal Server Error - /air/orders/print-label: - post: - operationId: Print Label + patch: + summary: Set Date for orders + operationId: orderSetDate tags: - - Forwarding - description: Re-Print label for an existing Order + - Orders + description: Set Date for one or all active orders from a shipper to a future date. Past dates are not allowed except for yesterday parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" - $ref: "#/components/parameters/Content-Type" - $ref: "#/components/parameters/X-BusinessGUID" - $ref: "#/components/parameters/X-ClientId" + - name: shipper_account_number + in: query + description: Unique shipper number. Required for all updates. + required: true + schema: + type: string + example: "123456789" + maxLength: 9 + - name: order_number + in: query + description: Unique order number. Required for individual order updates. + required: false + schema: + type: string + pattern: "^[0-9]{13}$" + example: "3912088430001" + - name: old_date + in: query + description: The current date of the shipment(s). Required for moving all open shipments to a new date. + required: false + schema: + $ref: "#/components/schemas/ApolloDateV1" + - name: language + in: query + description: The language/culture that is being used for the API + required: false + schema: + type: string + example: "en-US" requestBody: required: true - description: Container for label details to be reprinted. + description: Container for the order details to be moved to another day. content: application/json: schema: - $ref: "#/components/schemas/ApolloOrderPrintLabelRequestV1" + $ref: "#/components/schemas/ApolloPatchReplaceReqV1" example: - shipperAccountNumber: 4492YY - orderNumber: "9100005950005" - format: PDF - layout: AF-GEMINI + - op: replace + path: /newDate + value: 2025-07-24 responses: "200": description: OK @@ -861,126 +882,12 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ApolloLabelV1" - examples: - PDFPNG: - summary: PDF or PNG - value: - labelFormat: PDF - shipmentNumber: "9100010271" - orderNumber: "9100010270001" - charges: - shipperCharges: - - code: AF - description: Air Freight - amount: "10.00" - currencyCode: USD - consigneeCharges: - - code: DL - description: Delivery Charges - amount: "10.00" - currencyCode: USD - labelImage: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== - DATA: - value: - labelFormat: DATA - shipmentNumber: "9100010271" - orderNumber: "9100010270001" - charges: - shipperCharges: - - code: AF - description: Air Freight - amount: "10.00" - currencyCode: USD - consigneeCharges: - - code: DL - description: Delivery Charges - amount: "10.00" - currencyCode: USD - labelData: - shipper: - company: ABC Inc - address1: 123 Som St - city: Atlanta - state: GA - postalCode: "30005" - countryCode: US - account: 1420YY - serviceCenterCode: ATL - contactName: Zeus - contactPhone: "8888888888" - contactEmail: test1@ups.com - consignee: - company: ABC Inc - address1: 123 Som St - city: Atlanta - state: GA - postalCode: "30005" - countryCode: US - account: 1420YY - serviceCenterCode: ATL - contactName: Zeus - contactPhone: "8888888888" - contactEmail: test1@ups.com - shipment: - shipmentNumber: "9100010271" - serviceType: AM - paymentType: PPD - pickupDate: 2025-10-22 - readyTime: 11:00:00 - closeTime: 17:00:00 - dropoffTime: 11:10:00 - weight: 54 - freightType: PALLET - orderDescription: Apparels - shipperReference: Z30010021 - consigneeReference: ABC123 - currency: USD - isMetric: "0" - countryOfManufacture: - - US - - MX - - CA - - GB - details: - - key: HAZMAT - value: "false" - - key: HAPU - value: "true" - - key: SAT - value: "false" - - key: CC - value: "false" - - key: CV - value: "0" - - key: CV-Currency - value: "USD" - - key: DV - value: "1000" - - key: DV-Currency - value: "USD" - - key: PICKUP - value: "true" - - key: DDU - value: "false" - - key: DDP - value: "false" - - key: RESPU - value: "true" - - key: RESDLV - value: "true" - - key: LIFTGTPU - value: "true" - - key: LIFTGTDLV - value: "true" - rates: - amount: 1526.74 - currencyCode: USD - sortCode: U-BOS - gateway: ATL - count: 2 - labelService: ND - serviceDesc: UPS Next Day Air Freight - NGS + $ref: "#/components/schemas/ApolloOrderSetDateResponseV1" + example: + response: + shipmentNumber: "910001027" + orderNumber: "9100010270001" + newDate: 2025-10-22 "400": description: Bad Request headers: @@ -1093,50 +1000,36 @@ paths: errors: - code: "1003" message: Internal Server Error - /air/orders/postpone: - patch: - operationId: Postpone Order + get: + summary: Order Search + operationId: orderSearch tags: - - Forwarding - description: Postpone one or all orders from a shipper to a future date. + - Orders + description: Search for orders based on criteria parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" - $ref: "#/components/parameters/Content-Type" - $ref: "#/components/parameters/X-BusinessGUID" - $ref: "#/components/parameters/X-ClientId" - - name: shipper_account_number - in: query - description: Unique shipper number. Required for all updates. - required: true - schema: - type: string - example: 4492YY - - name: order_number - in: query - description: Unique order number. Required for individual order updates. - required: false - schema: - type: string - example: "3912088430001" - - name: language - in: query - description: Unique order number. Optional for all updates. - required: false - schema: - type: string - example: "en-US" requestBody: required: true - description: Container for the order details to be postponed. + description: Container for filters to be applied to the search. content: application/json: schema: - $ref: "#/components/schemas/ApolloOrderPostponeRequestV1" + $ref: "#/components/schemas/ApolloOrderSearchRequestV1" example: - - op: replace - path: /newDate - value: 2025-07-24 + shipperAccountNumber: "123456789" + criteriaList: + - criteriaField: ORDER_STATUS + criteriaOperator: NOTEQ + criteriaValue: "8" + - criteriaField: SHIP_DATE + criteriaOperator: BTWN + criteriaValue: 2025-07-23 + criteriaValue2: 2025-07-24 + language: en-US responses: "200": description: OK @@ -1156,11 +1049,48 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ApolloOrderPostponeResponseV1" + $ref: "#/components/schemas/ApolloOrderSearchResponseV1" example: - shipmentNumber: "9100010270001" - orderNumber: "910001027" - newDate: 2025-10-22 + response: + orders: + - shipmentNumber: "906694886" + orderNumber: "9066948860001" + consignee: + account: "123456789" + serviceCenterCode: BOS + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: Sheldon + contactPhone: "8888888778" + contactEmail: test2@ups.com + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + shipDate: 2025-07-24 + statusCode: 8 + status: Posted + description: LOTS OF STUFF + manifestNumber: M934567890 + shipperReference: SHIPPER REF + consigneeReference: CONSIGNEE REF + isMetric: true + items: + totalWeight: 14 + weightUnit: LB + totalPieceCount: 2 + item: + - count: 1 + length: 10 + width: 10 + height: 10 + weight: 10 + - count: 1 + length: 10 + width: 10 + height: 10 + weight: 10 "400": description: Bad Request headers: @@ -1273,12 +1203,13 @@ paths: errors: - code: "1003" message: Internal Server Error - /air/orders/search: + /documents/labels: post: - operationId: Search Order + summary: Re-Print label + operationId: printLabel tags: - - Forwarding - description: Search for orders based on criteria + - Documents + description: Re-Print label for an existing Order parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -1287,22 +1218,16 @@ paths: - $ref: "#/components/parameters/X-ClientId" requestBody: required: true - description: Container for filters to be applied to the search. + description: Container for label details to be reprinted. content: application/json: schema: - $ref: "#/components/schemas/ApolloOrderSearchRequestV1" + $ref: "#/components/schemas/ApolloOrderPrintLabelRequestV1" example: - shipperAccountNumber: 4492YY - criteriaList: - - criteriaField: ORDER_STATUS - criteriaOperator: NOTEQ - criteriaValue: "8" - - criteriaField: SHIP_DATE - criteriaOperator: BTWN - criteriaValue: 2025-07-23 - criteriaValue2: 2025-07-24 - language: en-US + shipperAccountNumber: "123456789" + orderNumber: "9100005950005" + format: PDF + layout: AF-GEMINI responses: "200": description: OK @@ -1322,47 +1247,114 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ApolloOrderSearchResponseV1" + type: object + description: Response from the Print LAbel API + required: + - response + properties: + response: + $ref: "#/components/schemas/ApolloLabelV1" example: - orders: - - shipmentNumber: "906694886" - orderNumber: "9066948860001" + response: + labelFormat: PDF + shipmentNumber: "9100010271" + orderNumber: "9100010270001" + charges: + shipperCharges: + - code: AF + description: Air Freight + amount: "10.00" + currencyCode: USD + consigneeCharges: + - code: DL + description: Delivery Charges + amount: "10.00" + currencyCode: USD + labelImage: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== + labelData: + shipper: + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" + countryCode: US + account: "123456789" + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com consignee: - account: 4492YY - serviceCenterCode: BOS - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - contactName: Sheldon - contactPhone: "8888888778" - contactEmail: test2@ups.com - company: DHL INTERNATIONAL (UK) LTD. - address1: 99 Hereford Street - city: Cranston - state: RI - postalCode: "02920" + company: ABC Inc + address1: 123 Som St + city: Atlanta + state: GA + postalCode: "30005" countryCode: US - shipDate: 2025-07-24 - statusCode: 8 - status: Posted - description: LOTS OF STUFF - manifestNumber: M934567890 - shipperReference: SHIPPER REF - consigneeReference: CONSIGNEE REF - isMetric: true - items: - totalWeight: 14 - weightUnit: LB - totalPieceCount: 2 - item: - - count: 1 - length: 10 - width: 10 - height: 10 - weight: 10 - - count: 1 - length: 10 - width: 10 - height: 10 - weight: 10 + account: "123456789" + serviceCenterCode: ATL + contactName: Zeus + contactPhone: "8888888888" + contactEmail: test1@ups.com + shipment: + shipmentNumber: "9100010271" + serviceType: AM + paymentType: PPD + pickupDate: 2025-10-22 + readyTime: 11:00:00 + closeTime: 17:00:00 + dropoffTime: 11:10:00 + weight: 54 + freightType: PALLET + orderDescription: Apparels + shipperReference: Z30010021 + consigneeReference: ABC123 + currency: USD + isMetric: "0" + countryOfManufacture: + - US + - MX + - CA + - GB + details: + - key: HAZMAT + value: "false" + - key: HAPU + value: "true" + - key: SAT + value: "false" + - key: CC + value: "false" + - key: CV + value: "0" + - key: CV-Currency + value: "USD" + - key: DV + value: "1000" + - key: DV-Currency + value: "USD" + - key: PICKUP + value: "true" + - key: DDU + value: "false" + - key: DDP + value: "false" + - key: RESPU + value: "true" + - key: RESDLV + value: "true" + - key: LIFTGTPU + value: "true" + - key: LIFTGTDLV + value: "true" + rates: + amount: 1526.74 + currencyCode: USD + sortCode: U-BOS + gateway: ATL + count: 2 + labelService: ND + serviceDesc: UPS Next Day Air Freight - NGS "400": description: Bad Request headers: @@ -1475,30 +1467,62 @@ paths: errors: - code: "1003" message: Internal Server Error - /air/shipment: - post: - operationId: Submit Air Shipment + + /shipments: + patch: + summary: Processes all shipments + operationId: submitAirShipment tags: - - Forwarding - description: Processes all the shipment created for the particular shipper for the day and return a manifest. + - Shipments + description: Processes all shipments created for a specific shipper during the day and returns a manifest. parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" - $ref: "#/components/parameters/Content-Type" - $ref: "#/components/parameters/X-BusinessGUID" - $ref: "#/components/parameters/X-ClientId" + - name: shipper_account_number + in: query + description: Unique shipper number. Required for all updates. + required: true + schema: + type: string + example: "123456789" + maxLength: 9 + - name: pickup_date + in: query + description: The RFC 3339 scheduled pickup date. + required: false + schema: + $ref: "#/components/schemas/ApolloDateV1" + - name: request_manifest + in: query + description: The flag indicating whether a manifest should be generated. + required: false + schema: + type: boolean + example: true + - name: manifest_format + in: query + description: The format of the manifest to be generated. + required: false + schema: + type: string + example: "PDF" + enum: + - "DATA" + - "PDF" requestBody: required: true description: The request containing required details for processing submit request. content: application/json: schema: - $ref: "#/components/schemas/ApolloAirShipmentSubmitRequestV1" + $ref: "#/components/schemas/ApolloPatchReplaceReqV1" example: - account: 4492YY - pickupDate: 2025-07-24 - requestManifest: true - manifestFormat: PDF + - op: replace + path: /status + value: submitted responses: "200": description: OK @@ -1520,78 +1544,79 @@ paths: schema: $ref: "#/components/schemas/ApolloAirShipmentDataResponseV1" example: - account: 4492YY - pickupDate: 2025-07-24 - shipmentCount: 1 - pieceCount: 2 - weight: 200 - weightUnit: LBS - manifest: - manifestNumber: M810000091 - manifestFormat: DATA - shipper: - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - company: GEMINI SYSTEM INFORMATION - address1: 12380 MORRIS RD - city: Louisville - state: KY - postalCode: "40214" - countryCode: US - shipments: - - number: 1 - shipmentNumber: "9100010271" - serviceType: AM - paymentType: OTH/THD - weight: 54 - currency: USD - shipperReference: "36566355" - consigneeReference: "BATCH NO: B35" - consignee: - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - company: DHL INTERNATIONAL (UK) LTD. - address1: 99 Hereford Street - address2: "" - address3: "" - city: Cranston - state: RI - postalCode: "02920" - countryCode: US - summary: - services: - - serviceCode: CX - serviceName: UPS Express® Freight + response: + account: "123456789" + pickupDate: 2025-07-24 + shipmentCount: 1 + pieceCount: 2 + weight: 200 + weightUnit: LBS + manifest: + manifestNumber: M810000091 + manifestFormat: DATA + shipper: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: GEMINI SYSTEM INFORMATION + address1: 12380 MORRIS RD + city: Louisville + state: KY + postalCode: "40214" + countryCode: US + shipments: + - number: 1 + shipmentNumber: "9100010271" + serviceType: AM + paymentType: OTH/THD + weight: 54 + currency: USD + shipperReference: "36566355" + consigneeReference: "BATCH NO: B35" + consignee: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + address2: "" + address3: "" + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + summary: + services: + - serviceCode: CX + serviceName: UPS Express® Freight + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 55 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + - serviceCode: D2 + serviceName: UPS 2nd Day Air® Freight NGS + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 45.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + serviceTotal: freightChargesAmount: 24.45 surchargesAmount: 45.87 addedChargesAmount: 33.2 - billedAmount: 55 + billedAmount: 100.2 shipmentCount: 1 itemCount: 1 totalWeight: 20 - - serviceCode: D2 - serviceName: UPS 2nd Day Air® Freight NGS - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 45.2 + dailyPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + currentPickupTotals: shipmentCount: 1 itemCount: 1 totalWeight: 20 - serviceTotal: - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 100.2 - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - dailyPickupTotals: - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - currentPickupTotals: - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 "400": description: Bad Request headers: @@ -1677,10 +1702,11 @@ paths: - code: "1003" message: Internal Server Error delete: - operationId: Cancel Air Shipment + summary: Cancels a shipment + operationId: cancelAirShipment tags: - - Forwarding - description: Cancels a shipment based on the shipment number and shipper account number provided in the request. + - Shipments + description: Cancels a shipment using the provided shipment number and shipper's UPS Freight Account Number. parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -1694,7 +1720,7 @@ paths: schema: $ref: "#/components/schemas/ApolloAirShipmentCancelRequestV1" example: - shipperAccountNumber: 4492YY + shipperAccountNumber: "123456789" shipmentNumber: "391208843" language: en-US responses: @@ -1718,8 +1744,9 @@ paths: schema: $ref: "#/components/schemas/ApolloAirShipmentCancelResponseV1" example: - shipperAccountNumber: 4492YY - shipmentNumber: "9100010271" + response: + shipperAccountNumber: "123456789" + shipmentNumber: "9100010271" "400": description: Bad Request headers: @@ -1832,49 +1859,143 @@ paths: errors: - code: "1003" message: Internal Server Error - get: - operationId: Print Air Manifest + post: + summary: Freight Shipment + description: Generate estimated freight rates based on the provided shipment and party details, and create the shipment. + operationId: freightShip tags: - - Forwarding - description: Generates and returns the manifest for the specified manifest number in the requested format. + - Shipments parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" - $ref: "#/components/parameters/Content-Type" - $ref: "#/components/parameters/X-BusinessGUID" - - $ref: "#/components/parameters/X-ClientId" - - name: account_number - in: query - description: Shipper Account Number - required: true - schema: - type: string - example: 4492YY - - name: manifest_number - in: query - description: Manifest Number - required: true - schema: - type: string - example: M810000079 - - name: manifest_format - in: query - description: Manifest Format - required: true - schema: - type: string - enum: - - DATA - - name: language - in: query - description: Language - required: true - schema: - type: string - example: en-US + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApolloAirShipRequestV1' + example: + shipper: + account: "123456789" + address1: "123 Main St" + address2: "" + address3: "" + city: "New York" + state: "NY" + postalCode: "10001" + countryCode: "US" + serviceCenterCode: "NYC" + partyCode: "SHIP123" + company: "Shipper Inc" + contactName: "John Doe" + contactPhone: "+1-555-1234" + contactEmail: "john.doe@shipper.com" + partySectionDetails: + "part": "p434567" + details: + - key: serialNumber + value: SN654321 + consignee: + account: "" + address1: "456 Market St" + address2: "" + address3: "" + city: "San Francisco" + state: "CA" + postalCode: "94105" + countryCode: "US" + serviceCenterCode: "SFO" + partyCode: "CON123" + company: "Consignee LLC" + contactName: "Jane Smith" + contactPhone: "+1-555-5678" + contactEmail: "jane.smith@consignee.com" + partySectionDetails: + department: "Receiving" + details: + - key: serialNumber + value: SN654321 + thirdParty: + company: Third Party Logistics + account: "123456789" + address1: 7890 LOGISTICS RD + address2: "" + address3: "" + city: ATLANTA + state: GA + postalCode: "30303" + countryCode: US + serviceCenterCode: ATL + partyCode: CID-123456789 + contactName: John + contactPhone: "777777777" + contactEmail: john@example.com + partySectionDetails: + "part": "p434567" + details: + - key: serialNumber + value: SN654321 + shipment: + serviceType: "AM" + paymentType: "PPD" + pickupDate: "2025-08-11" + readyTime: "09:00" + closeTime: "17:00" + dropoffTime: 16:00 + weight: 25.5 + freightType: "PALLET" + isMetric: true + description: "Electronics shipment" + shipperReference: "REF123" + consigneeReference: "CREF456" + currency: "USD" + requestPickup: true + requestBoL: false + countryOfManufacture: ["US"] + items: + - description: "Laptop" + count: 10 + length: 38.5 + width: 25.0 + height: 2.5 + weight: 2.0 + details: + - key: serialNumber + value: SN654321 + - description: "Monitor" + count: 5 + length: 60.0 + width: 35.0 + height: 8.0 + weight: 5.5 + details: + - key: serialNumber + value: SN654321 + details: + - key: IsHAZMAT + value: "true" + - key: IsHazmatPassengerAircraft + value: "true" + - key: DV + value: "1000" + - key: DV-Currency + value: "USD" + label: + layout: "AF-GEMINI" + format: "PDF" + details: + PieceCount: "3" + Model_Number: "X" + Model_Year: "2023" + Shipper_ReferenceNo: "SHP2401-A3MC220" + language: "en-us" + transactionId: "txn-0016ty675r5" responses: "200": - description: OK + description: Success headers: BkndTransId: $ref: "#/components/headers/BkndTransId" @@ -1891,83 +2012,43 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ApolloAirShipmentDataResponseV1" + $ref: '#/components/schemas/ApolloAirShipResponseV1' example: - account: 4492YY - pickupDate: 2025-07-24 - shipmentCount: 1 - pieceCount: 2 - weight: 200 - weightUnit: LBS - manifest: - manifestNumber: M810000091 - manifestFormat: DATA - shipper: - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - company: GEMINI SYSTEM INFORMATION - address1: 12380 MORRIS RD - address2: "" - address3: "" - city: Louisville - state: KY - postalCode: "40214" - countryCode: US - shipments: - - number: 1 - shipmentNumber: "9100010271" - serviceType: AM - paymentType: OTH/THD - weight: 54 - orderDescription: "Lots of Stuff" - currency: USD - shipperReference: Z30010021 - consigneeReference: ABC123 - consignee: - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - company: DHL INTERNATIONAL (UK) LTD. - address1: 99 Hereford Street - address2: "" - address3: "" - city: Cranston - state: RI - postalCode: "02920" - countryCode: US - summary: - services: - - serviceCode: CX - serviceName: UPS Express® Freight - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 55 - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - - serviceCode: D2 - serviceName: UPS 2nd Day Air® Freight NGS - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 45.2 - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - serviceTotal: - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 100.2 - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - dailyPickupTotals: - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - currentPickupTotals: - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 + response: + shipmentNumber: "986756456T" + prqNumber: "PRQ123456" + prqStatus: "CONFIRMED" + originServiceCenter: "NYC" + destinationServiceCenter: "SFO" + paymentType: "PPD" + rates: + - serviceType: "AM" + guaranteedDelivery: true + deliveryTime: "2025-08-12T10:00:00Z" + holdAtAirportTime: "2025-08-12T12:00:00Z" + totalCharge: 150.75 + currency: "USD" + billableWeight: 30.0 + weightUnit: "KG" + dimensionalWeight: 28.0 + minimumBillableWeightApplied: false + contractRate: false + charges: + - role: "SHPR" + code: "FRT" + description: "Freight Charge" + amount: 120.00 + currency: "USD" + - role: "SHPR" + code: "FSC" + description: "Fuel Surcharge" + amount: 30.75 + currency: "USD" + label: + format: "PDF" + layout: "AF-GEMINI" + labelT: "Base64EncodedLabelString" + image: "Base64EncodedPDF" "400": description: Bad Request headers: @@ -1994,7 +2075,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -2022,36 +2103,8 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. - "404": - description: Resource Not Found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - X-BusinessGUID: - $ref: "#/components/headers/X-BusinessGUID" - X-ClientId: - $ref: "#/components/headers/X-ClientId" - content: - application/json: - schema: - $ref: "#/components/schemas/ApolloErrorResponseV1" - example: - response: - errors: - - code: "9999" - message: The requested resource was not found. "500": description: Server Error headers: @@ -2078,36 +2131,53 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error - /air/utility/city-details: - get: - operationId: getCity + + /documents/manifest: + post: + summary: Print Air Manifest + operationId: printAirManifest tags: - - Forwarding - summary: City Data - description: This endpoint retrieves the city details based on the search criteria provided. + - Documents + description: Generates and returns the manifest for the specified manifest number in the requested format. parameters: - - name: shipper_accountnumber - in: query - schema: - type: string - - name: country + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: account_number in: query + description: Shipper's UPS Freight Account Number + required: true schema: type: string - - name: city + example: "123456789" + - name: manifest_number in: query + description: Manifest Number + required: true schema: type: string - - name: criteria_operator + example: M810000079 + maxLength: 10 + - name: manifest_format in: query + description: Manifest Format + required: true schema: type: string - - name: postal + enum: + - DATA + - PDF + - name: language in: query + description: Language + required: false schema: type: string + example: en-US responses: "200": description: OK @@ -2120,10 +2190,6 @@ paths: $ref: "#/components/headers/transactionSrc" Content-Type: $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2131,15 +2197,84 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ApolloGetCityResponseV1" + $ref: "#/components/schemas/ApolloAirShipmentDataResponseV1" example: - cityDetails: - - stateProvinceCode: GA - cityName: ATLANTA - majorAirportCity: YVR - tariffDestination: ATL - sortCode: V1 - standardService: BND + response: + account: "123456789" + pickupDate: 2025-07-24 + shipmentCount: 1 + pieceCount: 2 + weight: 200 + weightUnit: LBS + manifest: + manifestNumber: M810000091 + manifestFormat: DATA + shipper: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: GEMINI SYSTEM INFORMATION + address1: 12380 MORRIS RD + address2: "" + address3: "" + city: Louisville + state: KY + postalCode: "40214" + countryCode: US + shipments: + - number: 1 + shipmentNumber: "9100010271" + serviceType: AM + paymentType: OTH/THD + weight: 54 + orderDescription: "Lots of Stuff" + currency: USD + shipperReference: Z30010021 + consigneeReference: ABC123 + consignee: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + address2: "" + address3: "" + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + summary: + services: + - serviceCode: CX + serviceName: UPS Express® Freight + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 55 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + - serviceCode: D2 + serviceName: UPS 2nd Day Air® Freight NGS + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 45.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + serviceTotal: + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 100.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + dailyPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + currentPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 "400": description: Bad Request headers: @@ -2252,60 +2387,50 @@ paths: errors: - code: "1003" message: Internal Server Error - /payment/status/{session_id}: - patch: - summary: Status of payment authorizations - description: | - Provides a mechanism for Common Payment Capture (CPC) to send, in real-time, payment status to the Forwarding Hub. - - **Key Business Values** - - Supplements the CPC Pay-by-Link functionality - - Enhances user experience by automating payment status tracking. - - Reduces server load by eliminating repeated manual checks for status updates. - operationId: putPaymentAuthStatus - security: - - oauth2: [] + /info/cities: + get: + operationId: getCity tags: - - Forwarding + - Info + summary: citydata. + description: Retrieves city details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" - $ref: "#/components/parameters/Content-Type" - - name: session_id - in: path - description: The identifier for the session the payment was made in. + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: shipper_account_number + in: query + schema: + type: string + maxLength: 9 + description: Shipper's UPS Freight Account Number + - name: country + in: query required: true schema: type: string - minLength: 32 - maxLength: 36 - pattern: ^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$ - example: 1acbd41c-13fb-41c0-85f3-1954d69fa22e - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ApolloPaymentPatchV1' - examples: - payment-status-success: - summary: Successful Payment - value: - - op: add - path: /cardAuthStatus - value: '20001' - - op: add - path: /paymentGUID - value: 3437bfbe-fd57-4e50-9802-493b128c63e5 - payment-status-failure: - summary: Failed Payment - value: - - op: add - path: /cardAuthStatus - value: '40001' + description: Country Code. its required for this operation + - name: city + in: query + schema: + type: string + description: Partial City Name to search. It is required if the country is not 'US' or 'CA'. + - name: criteria_operator + in: query + schema: + type: string + description: Operator to apply on the city name search. Possible values are 'STARTS_WITH' and 'CONTAINS'. Default is 'STARTS_WITH'. + - name: postal + in: query + schema: + type: string + description: Postal Code to search. Its required if the country is 'US' or 'CA'. + responses: - "204": - description: Accepted + "200": + description: OK headers: BkndTransId: $ref: "#/components/headers/BkndTransId" @@ -2315,6 +2440,27 @@ paths: $ref: "#/components/headers/transactionSrc" Content-Type: $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloGetCityResponseV1" + example: + response: + cityDetails: + - stateProvinceCode: GA + cityName: ATLANTA + majorAirportCity: YVR + tariffDestination: ATL + sortCode: V1 + standardService: BND "400": description: Bad Request headers: @@ -2329,7 +2475,11 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" content: application/json: schema: @@ -2337,10 +2487,8 @@ paths: example: response: errors: - - code: "1000" - message: Malformed JSON syntax - code: "1001" - message: Required field missing + message: Required field missing "401": description: Unauthorized Request headers: @@ -2356,6 +2504,10 @@ paths: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" content: application/json: schema: @@ -2380,6 +2532,10 @@ paths: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" content: application/json: schema: @@ -2387,8 +2543,8 @@ paths: example: response: errors: - - code: "1004" - message: The provided session_id resource was not found. + - code: "9999" + message: The requested resource was not found. "500": description: Server Error headers: @@ -2403,16 +2559,802 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/ApolloErrorResponseV1" + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /info/currencies: + get: + operationId: getCurrencies + tags: + - Info + summary: retrieves currencies. + description: Retrieves the currency details matching the provided search criteria. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: shipper_account_number + in: query + schema: + type: string + + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/CurrenciesResponseV1" + example: + response: + currencies: + - currencyCode: USD + currencyName: United States Dollar + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "9999" + message: The requested resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /info/payment-types: + get: + operationId: getAirPaymentTypes + tags: + - Info + summary: get payment types. + description: Retrieves payment types matching the provided search criteria. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: shipper_account_number + in: query + required: true + schema: + type: string + description: Shipper's UPS Freight Account Number and its required for this operation + - name: code + in: query + schema: + type: string + description: Payment type code + - name: incoterm_code + in: query + schema: + type: string + description: Incoterm code + - name: movement_type_code + in: query + schema: + type: string + description: Movement type code + - name: origin_country_code + in: query + schema: + type: string + description: Origin country code + - name: destination_country_code + in: query + schema: + type: string + description: Destination country code + - name: service_line + in: query + schema: + type: string + description: Service line code + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/PaymentTypeResponseV1" + example: + response: + paymentTypes: + - code: "PPD" + description: Invoice to the shipper + incoTermCode: CIP + type: SHPR + movementTypeCode: ATA + serviceGroupName: NAAF + serviceLine: AIR + - code: "OTH/CON" + description: Third-Party Payor + incoTermCode: FOB + type: THRD + movementTypeCode: ATD + serviceGroupName: IAF + serviceLine: AIR + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "9999" + message: The requested resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1003" + message: Internal Server Error + /info/countries: + get: + operationId: getCountries + tags: + - Info + summary: country data. + description: Retrieves country details matching the provided search criteria. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: shipper_account_number + in: query + schema: + type: string + + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/CountryCodeResponseV1" + example: + response: + countries: + - countryCode: US + countryName: United States + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "9999" + message: The requested resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" example: response: errors: - code: "1003" message: Internal Server Error + /info/airports: + get: + summary: Get Airport Details + description: Retrieve airport details by country code. + operationId: getAirportDetails + tags: + - Info + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - $ref: "#/components/parameters/country_code" + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloUtilityAirportDetailResponseV1" + example: + response: + airportDetails: + - city: "New York" + airportCode: "JFK" + postalCode: "11430" + stateProvince: "NY" + - city: "Los Angeles" + airportCode: "LAX" + postalCode: "90045" + stateProvince: "CA" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMsg: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: "Required field missing" + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMsg: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: "Invalid Authentication Information." + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMsg: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: "Internal Server Error" + /info/service-types: + get: + summary: Get Service Types + description: Retrieves available service types based on shipper and consignee information. + operationId: getServiceTypes + tags: + - Info + parameters: + - $ref: "#/components/parameters/shipper_city" + - $ref: "#/components/parameters/shipper_state_code" + - $ref: "#/components/parameters/shipper_postal_code" + - $ref: "#/components/parameters/shipper_country_code" + - $ref: "#/components/parameters/consignee_city" + - $ref: "#/components/parameters/consignee_state_code" + - $ref: "#/components/parameters/consignee_postal_code" + - $ref: "#/components/parameters/consignee_country_code" + - $ref: "#/components/parameters/shipper_account_number" + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ServiceTypeSearchResponseV1" + example: + response: + serviceTypes: + - code: "AMG" + description: "UPS NEXT DAY AIR FREIGHT" + - code: "DF" + description: "UPS 3 DAY FREIGHT NGS" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMsg: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: "Invalid request" + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMsg: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: "Invalid Authentication Information." + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMsg: + $ref: "#/components/headers/APIErrorMsg" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: "Internal Server Error" components: securitySchemes: oauth2: @@ -2464,18 +3406,124 @@ components: required: true schema: type: string - minLength: 36 - maxLength: 36 - pattern: '^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$' - example: 63A70EB9-3BB5-4617-A659-09D2E7027A85 - X-ClientId: - name: X-ClientId - in: header - description: Unique client Id. + minLength: 36 + maxLength: 36 + pattern: '^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$' + example: 12345678-34CD-1233-A678-B00000000000 + X-ClientId: + name: X-ClientId + in: header + description: Unique client Id. + required: true + schema: + type: string + example: 12345678-12AB-1234-A789-00000000000A + #ServiceTypeSearch + shipper_city: + name: shipper_city + in: query + required: false + description: Shipper city. + schema: + type: string + minLength: 1 + maxLength: 50 + example: "Atlanta" + shipper_state_code: + name: shipper_state_code + in: query + required: false + description: Shipper state code (2-letter code). + schema: + type: string + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: "GA" + shipper_postal_code: + name: shipper_postal_code + in: query + required: false + description: Shipper postal code. + schema: + type: string + minLength: 3 + maxLength: 10 + example: "30301" + shipper_country_code: + name: shipper_country_code + in: query + required: false + description: The shipper country code is required when the shipper account number is not provided. + schema: + type: string + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: "US" + consignee_city: + name: consignee_city + in: query + required: false + description: Consignee city. + schema: + type: string + minLength: 1 + maxLength: 50 + example: "London" + consignee_state_code: + name: consignee_state_code + in: query + required: false + description: Consignee state code (2-letter code). + schema: + type: string + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: "LN" + consignee_postal_code: + name: consignee_postal_code + in: query + required: false + description: Consignee postal code. + schema: + type: string + minLength: 3 + maxLength: 10 + example: "SW1A1AA" + consignee_country_code: + name: consignee_country_code + in: query + required: true + description: Consignee country code (2-letter ISO). + schema: + type: string + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: "GB" + shipper_account_number: + name: shipper_account_number + in: query + required: false + description: Shipper account number. + schema: + type: string + minLength: 6 + maxLength: 12 + example: "123456789" + country_code: + name: country_code + in: query + description: ISO country code used to filter airport data. required: true schema: type: string - example: N45123456789 + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2} + example: US headers: BkndTransId: description: The backend transaction id. @@ -2524,7 +3572,7 @@ components: required: true schema: type: string - example: N45123456789 + example: 12345678-12AB-1234-A789-00000000000A X-BusinessGUID: description: Unique business GUID. required: true @@ -2533,7 +3581,7 @@ components: minLength: 36 maxLength: 36 pattern: '^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$' - example: 63A70EB9-3BB5-4617-A659-09D2E7027A85 + example: 12345678-34CD-1233-A678-B00000000000 schemas: #/air/rate ApolloAirFreightRateRequestV1: @@ -2641,1805 +3689,2491 @@ components: maxLength: 3 pattern: '^[A-Z]{3}' example: USD - requestPickup: - type: boolean - description: Indicates whether a pickup request is included. - default: false - requestBoL: - type: boolean - description: Indicates whether a Bill of Lading (BoL) is requested. + requestPickup: + type: boolean + description: Indicates whether a pickup request is included. + default: false + requestBoL: + type: boolean + description: Indicates whether a Bill of Lading (BoL) is requested. + default: false + countryOfManufacture: + type: array + description: The unbounded list of country codes where the goods were manufactured. + minItems: 1 + items: + description: | + The ISO 3166 + code of the country participating in the goods manufacture. + $ref: "#/components/schemas/ApolloCountryCodeV1" + items: + type: array + description: Unbounded list of items in the shipment. + minItems: 1 + items: + type: object + description: Item information within a shipment. + required: + - count + - length + - width + - height + - weight + properties: + description: + type: string + description: Description of the item. + example: Laptop + count: + type: integer + description: Quantity of the item. + maximum: 99999 + example: 1 + length: + description: Length of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + width: + description: Width of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + height: + description: Height of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + weight: + type: number + format: float + description: Weight of the item. + minimum: 0.1 + maximum: 999999.99 + examples: + - 15 + - 6.84 + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + language: + type: string + description: Language preference for the response. + example: en-US + transactionId: + type: string + description: Unique transaction ID for debugging and tracking. + example: N29245123456789 + additionalProperties: false + ApolloAirFreightRateResponseV1: + type: object + description: This object provides the rate calculation response. + required: + - response + properties: + response: + type: object + required: + - rates + properties: + rates: + type: array + description: Unbounded list of calculated rates. + minItems: 1 + items: + type: object + description: Details of a calculated rate. + required: + - serviceType + - guaranteedDelivery + - deliveryTime + - holdAtAirportTime + - totalCharge + - billableWeight + - weightUnit + - dimensionalWeight + - minimumBillableWeightApplied + - contractRate + - charges + properties: + serviceType: + type: string + description: Service type for the rate. + example: AM + guaranteedDelivery: + type: boolean + description: Indicates if delivery is guaranteed. + default: false + deliveryTime: + description: The estimated delivery time. + $ref: "#/components/schemas/ApolloDateTimeV1" + holdAtAirportTime: + description: The hold at airport time. + $ref: "#/components/schemas/ApolloDateTimeV1" + totalCharge: + description: Total charge for the shipment. + $ref: "#/components/schemas/ApolloChargeAmountV1" + billableWeight: + description: The billable weight. + $ref: "#/components/schemas/ApolloWeightV1" + weightUnit: + type: string + description: The Weight unit used. + enum: + - LBS + - KGS + dimensionalWeight: + description: The dimensional weight. + $ref: "#/components/schemas/ApolloWeightV1" + minimumBillableWeightApplied: + type: boolean + description: Indicates if the minimum billable weight was applied. + default: false + contractRate: + type: boolean + description: Indicates if the contract rate applies. + default: false + charges: + type: array + minItems: 1 + description: Unbounded list of charges applied + items: + type: object + properties: + role: + type: string + description: The role of charge + example: Carrier + code: + type: string + description: The charge code + example: FRT + description: + type: string + description: The charge Description + example: Air Freight Shipping - Included + amount: + type: number + description: The charge amount + example: 250.75 + currencyCode: + type: string + description: The type of currency associated with the charge + example: USD + additionalProperties: false + additionalProperties: false + + #/air/orders + ApolloOrderRequestV1: + type: object + required: + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Shipper associated with the Shipment. + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Consignee associated with the Shipment. UPS Freight Account Number is required if the consignee is the payor. must be different Shipper + thirdParty: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Any other Party involved in the Shipment, usually a payor. Details Required when third party is payor, must be different from consignee and shipper + shipment: + type: object + required: + - pickupDate + - freightType + - items + - currency + - isMetric + - paymentType + - serviceType + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + type: + - string + - "null" + enum: + - AMG + - AM + - D2G + - D2 + - DFG + - DF + - CX + - CA + - EC + - MEXDF + - SAT + - SATG + - GOLDP + - CXD + - CXC + - CXCD + - CAD + - CAC + - CACD + - ECD + - ECC + - ECCD + - EG + - EA + example: AM + description: Type of service requested + maxLength: 6 + paymentType: + type: + - string + - "null" + maxLength: 10 + example: PPD + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The pickup ready time. + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. Required if items are missing weight entry + format: float + maximum: 999999.99 + example: 54 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + orderDescription: + description: A short description of the Shipment Order + type: + - string + - "null" + example: WIDGETS + maxLength: 30 + shipperReference: + description: A reference to the shipment provided by the Shipper + type: + - string + - "null" + example: ABC123 + maxLength: 30 + consigneeReference: + description: A reference to the shipment provided by the Consignee + type: + - string + - "null" + example: Z30010021 + maxLength: 30 + currency: + description: The currency code associated with the Shipment. Default is USD + type: + - string + - "null" + example: USD + isMetric: + description: A flag to indicate if the measurements are metric + type: + - boolean + - "null" default: false - countryOfManufacture: + items: type: array - description: The unbounded list of country codes where the goods were manufactured. + description: A collection of the details of each item that is associated with the Shipment minItems: 1 items: - description: | - The ISO 3166 - code of the country participating in the goods manufacture. - $ref: "#/components/schemas/ApolloCountryCodeV1" - items: - type: array - description: Unbounded list of items in the shipment. + $ref: "#/components/schemas/ApolloItemV1" + countryOfManufacture: + description: An unbounded array of country codes where the items originated minItems: 1 + type: array items: - type: object - description: Item information within a shipment. - required: - - count - - length - - width - - height - - weight - properties: - description: - type: string - description: Description of the item. - example: Laptop - count: - type: integer - description: Quantity of the item. - maximum: 99999 - example: 1 - length: - description: Length of the item. - $ref: "#/components/schemas/ApolloDimensionV1" - width: - description: Width of the item. - $ref: "#/components/schemas/ApolloDimensionV1" - height: - description: Height of the item. - $ref: "#/components/schemas/ApolloDimensionV1" - weight: - type: number - format: float - description: Weight of the item. - minimum: 0.1 - maximum: 999999.99 - examples: - - 15 - - 6.84 - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false + type: + - string + - "null" + maxLength: 3 + example: US + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + label: + type: object + required: + - format + properties: + layout: + description: A key that determines the template that is used for the label. + type: + - string + - "null" + maxLength: 40 + example: AF-GEMINI + format: + description: The output format of the document. + type: + - string + - "null" + enum: + - PDF + - PNG + - JPG + - BMP + - TIFF + - SVG + - DATA details: + description: Additional details needed for the label. May include the custom fields that the label template supports $ref: "#/components/schemas/ApolloCustomArrayV1" additionalProperties: false language: + description: The language/culture that is being used for the API type: string - description: Language preference for the response. + maxLength: 6 + transId: + description: A transaction Id to track this API call + type: string + additionalProperties: false + ApolloOrderResponseV1: + type: object + description: Response from the Order API + required: + - response + properties: + response: + allOf: + - $ref: "#/components/schemas/ApolloLabelV1" + - type: object + required: + - shipmentNumber + - orderNumber + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: true + ApolloCancelOrderRequestV1: + description: The request used to cancel an Order + type: object + required: + - account + - orderNumber + properties: + account: + description: The unique number that identifies the Shipment + type: + - string + - "null" + example: "123456789" + maxLength: 9 + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + language: + description: The language/culture that is being used for the API + type: string + maxLength: 6 + example: en-US + additionalProperties: false + ApolloCancelOrderResponseV1: + type: object + description: The response from Order Cancel Operation + required: + - response + properties: + response: + type: object + required: + - shipmentNumber + - orderNumber + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: false + + #/air/orders/print-label + ApolloOrderPrintLabelRequestV1: + description: The API request used to print a Label + type: object + required: + - shipperAccountNumber + - orderNumber + - layout + - format + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + layout: + description: A key that determines the template that is used for the label. + type: + - string + - "null" + minLength: 1 + maxLength: 40 + example: AF-GEMINI + format: + description: The output format of the document. + type: + - string + - "null" + minLength: 1 + example: PDF + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + + #/air/orders/set-date: + # ApolloOrderSetDateRequestV1: + # $ref: "#/components/schemas/ApolloPatchReplaceReqV1" + # additionalProperties: false + ApolloOrderSetDateResponseV1: + description: The response from the date change operation + type: object + required: + - response + properties: + response: + type: + - object + - "null" + required: + - shipmentNumber + - orderNumber + - newDate + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + newDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + + #/air/orders/search + ApolloOrderSearchRequestV1: + type: object + required: + - shipperAccountNumber + - criteriaList + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + criteriaList: + description: An array of search criteria + type: + - array + - "null" + minItems: 1 + maxItems: 12 + items: + type: + - object + - "null" + required: + - criteriaField + - criteriaOperator + - criteriaValue + properties: + criteriaField: + description: The field that is used for search + type: + - string + - "null" + minLength: 1 + example: SHIP_DATE + criteriaOperator: + description: The Operator used in the search + type: + - string + - "null" + minLength: 1 + example: BTWN + criteriaValue: + description: The value that is used in the search + type: + - string + - "null" + minLength: 1 + example: "8" + criteriaValue2: + description: The value that is used in the search + type: + - string + - "null" + minLength: 1 + example: 2025-07-23 + additionalProperties: false + language: + description: The language/culture used in the request + type: + - string + - "null" example: en-US - transactionId: - type: string - description: Unique transaction ID for debugging and tracking. - example: N29245123456789 additionalProperties: false - ApolloAirFreightRateResponseV1: + ApolloOrderSearchResponseV1: + description: The response provided by the Apollo Order Search API type: object - description: This object provides the rate calculation response. - required: - - response - properties: + required: + - response + properties: response: type: object required: - - rates + - orders properties: - rates: + orders: type: array - description: Unbounded list of calculated rates. minItems: 1 + maxItems: 5000 items: - type: object - description: Details of a calculated rate. + type: + - object + - "null" required: - - serviceType - - guaranteedDelivery - - deliveryTime - - holdAtAirportTime - - totalCharge - - currencyCode - - billableWeight - - weightUnit - - dimensionalWeight - - minimumBillableWeightApplied - - contractRate - - charges + - shipmentNumber + - orderNumber + - consignee + - shipDate + - statusCode + - status + - description + - manifestNumber + - shipperReference + - consigneeReference + - isMetric + - items properties: - serviceType: - type: string - description: Service type for the rate. - example: AM - guaranteedDelivery: - type: boolean - description: Indicates if delivery is guaranteed. - default: false - deliveryTime: - description: The estimated delivery time. - $ref: "#/components/schemas/ApolloDateTimeV1" - holdAtAirportTime: - description: The hold at airport time. - $ref: "#/components/schemas/ApolloDateTimeV1" - totalCharge: - description: Total charge for the shipment. - $ref: "#/components/schemas/ApolloChargeV1" - currencyCode: - type: string - description: Currency code for the rate. - example: USD - billableWeight: - description: The billable weight. - $ref: "#/components/schemas/ApolloWeightV1" - weightUnit: - type: string - description: The Weight unit used. - enum: - - LBS - - KGS - dimensionalWeight: - description: The dimensional weight. - $ref: "#/components/schemas/ApolloWeightV1" - minimumBillableWeightApplied: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: The consignee associated with the Shipment + shipDate: + description: The RFC 3339 scheduled ship date. + $ref: "#/components/schemas/ApolloDateV1" + statusCode: + description: TThe code indicating the status of the Order + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 8 + status: + description: The description of the status of the Order + type: + - string + - "null" + minLength: 1 + example: POSTED + description: + description: The description of the Order + type: + - string + - "null" + minLength: 1 + example: Lots of stuff + manifestNumber: + description: The unique Id to identify the Manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + shipperReference: + description: The reference provided by Shipper + type: + - string + - "null" + minLength: 1 + example: SHIPPER REF + consigneeReference: + description: The reference provided by Consignee + type: + - string + - "null" + minLength: 1 + example: CONSIGNEE REF + isMetric: + description: The flag indicating whether the measurements are metric type: boolean - description: Indicates if the minimum billable weight was applied. default: false - contractRate: - type: boolean - description: Indicates if the contract rate applies. - default: false - charges: - type: array - minItems: 1 - description: Unbounded list of charges applied - items: - type: object - properties: - role: - type: string - description: The role of charge - example: Carrier - code: - type: string - description: The charge code - example: FRT - description: - type: string - description: The charge Description - example: Air Freight Shipping - Included - amount: - type: number - description: The charge amount - example: 250.75 - currencyCode: - type: string - description: The type of currency associated with the charge - example: USD + items: + type: object + required: + - totalWeight + - weightUnit + - totalPieceCount + properties: + totalWeight: + description: The total weight of the Items in the Order + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 14 + weightUnit: + description: The tunits used to calculate weight + type: + - string + - "null" + enum: + - LB + totalPieceCount: + description: The total number of Pieces in the Order + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + item: + description: The unbounded array of individual items in the Order + type: array + minItems: 1 + items: + type: + - object + - "null" + required: + - count + - length + - width + - height + - weight + properties: + count: + description: The number of components in the item + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 1 + length: + description: The length of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + width: + description: The width of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + height: + description: The height of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + weight: + description: The weight of each component in the item + type: number + format: float + minimum: 1 + minLength: 1 + example: 10 + additionalProperties: false + additionalProperties: false additionalProperties: false - additionalProperties: false + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: true - #/air/orders - ApolloOrderRequestV1: + #/air/shipment + # ApolloAirShipmentSubmitRequestV1: + # $ref: "#/components/schemas/ApolloPatchReplaceReqV1" + # additionalProperties: false + + ApolloAirShipmentDataResponseV1: type: object - required: - - shipper - - consignee - - shipment - properties: - shipper: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: Shipper associated with the Shipment. - consignee: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: Consignee associated with the Shipment. - thirdParty: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: Any other Party involved in the Shipment, usually a payor - shipment: + description: Response from the Shipment API + required: + - response + properties: + response: type: object required: + - account - pickupDate - - freightType - - items - - currency - - isMetric + - shipmentCount + - pieceCount + - weight + - weightUnit + - manifest properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - serviceType: - type: - - string - - "null" - example: AM - paymentType: - description: Type of service requested - type: - - string - - "null" - maxLength: 4 - example: PPD + account: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" pickupDate: description: The RFC 3339 scheduled pickup date. $ref: "#/components/schemas/ApolloDateV1" - readyTime: - description: The pickup ready time. - $ref: "#/components/schemas/ApolloTimeV1" - closeTime: - description: The location close time. - $ref: "#/components/schemas/ApolloTimeV1" - dropoffTime: - description: The shipment dropoff time. - $ref: "#/components/schemas/ApolloTimeV1" + shipmentCount: + description: The count of all Shipments that are submitted for processing + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + pieceCount: + description: The count of all peieces in all the shipments submitted + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 weight: + description: The total weight of all the shipments type: number - description: Total weight of the shipment. format: float - maximum: 999999.99 - example: 54 - freightType: - type: string - description: Freight type of the shipment. - enum: - - PALLET - - LOOSE - orderDescription: - description: A short description of the Shipment Order - type: - - string - - "null" - example: WIDGETS - shipperReference: - description: A reference reference to the shipment provided by the Shipper - type: - - string - - "null" - example: ABC123 - consigneeReference: - description: A reference reference to the shipment provided by the Consignee + minimum: 1 + minLength: 1 + example: 2 + weightUnit: + description: The unit used to measure the weight type: - string - "null" - example: Z30010021 - currency: - description: The currency code associated with the Shipment + manifest: + description: The manifest data that is returned if the format chosen is data + type: object + required: + - manifestNumber + - manifestFormat + - shipper + - shipments + properties: + manifestNumber: + description: The unique number used to identify a manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + manifestFormat: + description: The output format of the manifest + type: + - string + - "null" + minLength: 1 + example: PDF + shipper: + $ref: "#/components/schemas/ApolloShipmentAddressV1" + shipments: + description: An array of shipment details included in the manifest + type: + - array + - "null" + items: + type: + - object + - "null" + required: + - number + - shipmentNumber + - serviceType + - paymentType + - weight + - currency + - consignee + properties: + number: + description: The index of the shipment + type: integer + format: int32 + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + description: The service type used in the Shipment + type: + - string + - "null" + minLength: 1 + example: AM + paymentType: + description: The Payment type used in the shipment + type: + - string + - "null" + minLength: 1 + example: PPD + weight: + description: The total weight of the shipment + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + orderDescription: + description: A short description of the Order + type: + - string + - "null" + minLength: 1 + example: WIDGETS + currency: + description: The Acurrency used in the shipment + type: + - string + - "null" + minLength: 3 + maxLength: 3 + example: USD + shipperReference: + description: The reference provided by the shipper for the shipment + type: + - string + - "null" + minLength: 1 + example: ABC123 + consigneeReference: + description: The reference provided by the consignee for the shipment + type: + - string + - "null" + minLength: 1 + example: Z30010021 + consignee: + $ref: "#/components/schemas/ApolloShipmentAddressV1" + additionalProperties: false + summary: + type: object + required: + - services + - serviceTotal + - dailyPickupTotals + - currentPickupTotals + properties: + services: + description: The services used by the shipments and associated details + type: + - array + - "null" + items: + type: + - object + - "null" + required: + - shipmentCount + - itemCount + - totalWeight + - freightChargesAmount + - surchargesAmount + - addedChargesAmount + - billedAmount + - serviceCode + - serviceName + properties: + shipmentCount: + description: number of shipments using this service associated with this manifest + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + itemCount: + description: The total number items in those shipments + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + totalWeight: + description: The Atotal weight of those items + type: number + format: double + minLength: 1 + minimum: 1 + example: 3 + freightChargesAmount: + description: The total charges for this service + $ref: "#/components/schemas/ApolloAmountV1" + surchargesAmount: + description: The total surcharges for this service associated with this manifest + $ref: "#/components/schemas/ApolloAmountV1" + addedChargesAmount: + description: The total added charges for this service associated with this manifest + $ref: "#/components/schemas/ApolloAmountV1" + billedAmount: + description: Total Billed amount for this service + $ref: "#/components/schemas/ApolloAmountV1" + serviceCode: + description: The code for this service + type: + - string + - "null" + minLength: 1 + example: "01" + serviceName: + description: The name of the service + type: + - string + - "null" + minLength: 1 + example: "Next Day Air Early AM" + additionalProperties: false + serviceTotal: + type: object + description: The total for all services + required: + - shipmentCount + - itemCount + - totalWeight + - freightChargesAmount + - surchargesAmount + - addedChargesAmount + - billedAmount + properties: + shipmentCount: + description: The total number of shipments + type: integer + format: int32 + itemCount: + description: The total count of shipments + type: integer + format: int32 + totalWeight: + description: The total weight of shipments + type: number + format: double + freightChargesAmount: + description: total freight charges associated with the shipments in the manifest + type: number + format: double + surchargesAmount: + description: total surcharges associated with the shipments in the manifest + type: number + format: double + addedChargesAmount: + description: total added charges associated with the shipments in the manifest + type: number + format: double + billedAmount: + description: total billed charges associated with the shipments in the manifest + type: number + format: double + additionalProperties: false + dailyPickupTotals: + $ref: "#/components/schemas/ApolloPickupTotalV1" + currentPickupTotals: + $ref: "#/components/schemas/ApolloPickupTotalV1" + additionalProperties: false + additionalProperties: false + manifestNumber: + description: The unique number to identify the manifest type: - string - "null" - example: USD - isMetric: - description: A flag to indicate if the measurements are metric - type: - - boolean - - "null" - default: false - items: - type: array - description: A collection of the details of each item that is associated with the Shipment - minItems: 1 - items: - $ref: "#/components/schemas/ApolloCustomArrayV1" - countryOfManufacture: - description: An unbounded array of country codes where the items originated - minItems: 1 - type: array - items: - type: - - string - - "null" - maxLength: 3 - example: US - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false - label: - type: object - required: - - format - properties: - layout: - description: A key that determines the template that is used for the label. + minLength: 1 + example: M934567890 + manifestFormat: + description: The output format of the manifest type: - string - "null" - maxLength: 40 - example: AF-GEMINI - format: - description: The output format of the document. + minLength: 1 + example: PDF + manifestPDF: + description: The base64 string representing the byte array of the generated PDF type: - string - "null" - details: - description: Additional details needed for the label. May include the custom fields that the label template supports - $ref: "#/components/schemas/ApolloCustomArrayV1" + format: byte + example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string additionalProperties: false + ApolloAirShipmentCancelRequestV1: + type: object + required: + - shipperAccountNumber + - shipmentNumber + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" language: description: The language/culture that is being used for the API type: string + minLength: 1 maxLength: 6 - transId: - description: A transaction Id to track this API call - type: string + example: en-US additionalProperties: false - ApolloOrderResponseV1: - allOf: - - $ref: "#/components/schemas/ApolloLabelV1" - - type: object + ApolloAirShipmentCancelResponseV1: + type: object + description: Response from the Shipment Cancel API + required: + - response + properties: + response: + type: object required: - - shipmentNumber - - orderNumber + - shipperAccountNumber + - shipmentNumber properties: - shipmentNumber: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + shipmentNumber: $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - additionalProperties: true - ApolloCancelOrderRequestV1: - description: The request used to cancel an Order + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: false + + #/air/utility/city-details + ApolloGetCityResponseV1: + type: object + description: Response from the Order API + required: + - response + properties: + response: + type: object + required: + - cityDetails + properties: + cityDetails: + description: The unbounded array representing the cities + type: array + minItems: 1 + items: + type: + - object + - "null" + required: + - stateProvinceCode + properties: + stateProvinceCode: + description: The State/Province to which the city belongs to + type: + - string + - "null" + minLength: 1 + example: GA + cityName: + description: The name of the city + type: + - string + - "null" + minLength: 1 + example: Alpharetta + majorAirportCity: + description: The nearest city with a major airport + type: + - string + - "null" + minLength: 1 + example: Atlanta + tariffDestination: + description: The destination used for billing purpose + type: + - string + - "null" + minLength: 1 + example: ATL + sortCode: + description: A value which helps the Ops team to route the package + type: + - string + - "null" + minLength: 1 + example: V1 + standardService: + description: The standard service offered in this city + type: + - string + - "null" + minLength: 1 + example: GND + additionalProperties: false + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: false + #COMMON + ApolloAmountV1: + type: + - number + - "null" + format: double + examples: + - 10.00 + ApolloChargeAmountV1: type: object required: - - account - - orderNumber - - language + - amount + - currencyCode properties: - account: - description: The unique number that identifies the Shipment + amount: + type: + - string + - "null" + description: Cost associated with the charge + examples: + - "10.00" + - waived + - included + currencyCode: + description: The ISO 4217 charge currency code type: - string - "null" - example: 4492YY - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - language: - description: The language/culture that is being used for the API - type: string - maxLength: 6 - example: en-US - additionalProperties: false - ApolloCancelOrderResponseV1: - description: The response from Order Cancel Operation - type: object - required: - - shipmentNumber - - orderNumber - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - additionalProperties: false - - #/air/orders/print-label - ApolloOrderPrintLabelRequestV1: - description: The API request used to print a Label + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD + includedInd: + type: + - string + - "null" + additionalProperties: false + ApolloChargeV1: type: object required: - - shipperAccountNumber - - orderNumber - - layout - - format + - code + - amount + - currencyCode properties: - shipperAccountNumber: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - layout: - description: A key that determines the template that is used for the label. + code: + description: The code used to identify the charge for classification and categorization + type: + - string + - "null" + minLength: 1 + example: AF + description: + description: A short overview of the charge + type: + - string + - "null" + minLength: 1 + example: Air Freight + amount: + type: + - string + - "null" + description: Cost associated with the charge + examples: + - "10.00" + - waived + - included + currencyCode: + description: The ISO 4217 charge currency code type: - string - "null" - minLength: 1 - maxLength: 40 - example: AF-GEMINI - format: - description: The output format of the document. + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD + includedInd: type: - string - "null" - minLength: 1 - example: PDF - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false - - #/air/orders/postpone: - ApolloOrderPostponeRequestV1: + additionalProperties: false + ApolloCountryCodeV1: + type: string + minLength: 2 + maxLength: 2 + pattern: '^[A-Z]{2}' + example: US + ApolloCustomArrayV1: type: array - description: The unbounded list of objects to change with their values + description: Unbounded array of additional key-value pair objects minItems: 1 items: type: object - required: - - op - - path - - value + description: key-value pair object properties: - op: - type: - - string - - "null" - enum: - - replace - path: - type: - - string - - "null" - description: the field whose value is to be changed - example: /newDate + key: + type: string + description: the name referencing the paired object + minLength: 1 + example: HAZMAT value: - type: - - string - - "null" - description: new value to insert into the defined field - example: 2025-07-24 - additionalProperties: false - ApolloOrderPostponeResponseV1: - description: The response from the post pone operation + type: string + description: the value referencing the paired object + minLength: 1 + example: "true" + additionalProperties: false + ApolloDateV1: + type: string + format: date + pattern: "^((0[1-9]|1[0,1,2])/(0[1-9]|[12][0-9]|3[01])/(20)\\d{2})|((20)\\d{2}-(0[1-9]|1[0,1,2])-(0[1-9]|[12][0-9]|3[01]))$" + example: 2025-12-13 + ApolloDateTimeV1: + type: string + format: date-time + example: 2025-05-13 05:00:00 + ApolloDimensionV1: + type: number + format: float + minimum: 0.1 + maximum: 999.9 + examples: + - 15 + - 6.84 + ApolloWarningArrayV1: type: - - object - - "null" - required: - - shipmentNumber - - orderNumber - - newDate + - array + description: Unbounded array containing one or more warning objects + items: + type: object + description: Warning Entity + properties: + code: + type: string + description: warning code + minLength: 1 + example: "1050 " + message: + type: string + description: warning message + minLength: 1 + example: Consignee Contact Name too long. + required: + - code + - message + additionalProperties: false + ApolloErrorResponseV1: + type: object + description: Response object for errors properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - newDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" - - #/air/orders/search - ApolloOrderSearchRequestV1: + response: + type: object + description: Response container to store errors + properties: + errors: + type: array + description: Unbounded array containing one or more error objects + minItems: 1 + items: + type: object + description: Error entity + properties: + code: + type: string + description: error code + minLength: 1 + example: "250002" + message: + type: string + description: error message + minLength: 1 + example: Invalid Authentication Information. + required: + - code + - message + additionalProperties: false + required: + - errors + additionalProperties: false + required: + - response + additionalProperties: false + ApolloItemV1: type: object required: - - shipperAccountNumber + - itemDescription + - count + - length + - width + - height + - weight properties: - shipperAccountNumber: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - criteriaList: - description: An array of search criteria + itemDescription: + description: A short description of the item type: - - array + - string - "null" - minItems: 1 - maxItems: 12 - items: - type: - - object - - "null" - required: - - criteriaField - - criteriaOperator - - criteriaValue - properties: - criteriaField: - description: The field that is used for search - type: - - string - - "null" - minLength: 1 - example: SHIP_DATE - criteriaOperator: - description: The Operator used in the search - type: - - string - - "null" - minLength: 1 - example: BTWN - criteriaValue: - description: The value that is used in the search - type: - - string - - "null" - minLength: 1 - example: "8" - criteriaValue2: - description: The value that is used in the search - type: - - string - - "null" - minLength: 1 - example: 2025-07-23 - additionalProperties: false - language: - description: The language/culture used in the request + count: + description: A total number of this item type: - - string + - integer - "null" - example: en-US - additionalProperties: false - ApolloOrderSearchResponseV1: - description: The response provided by the Apollo Order Search API - type: object - required: - - orders - properties: - orders: - type: array - minItems: 1 - maxItems: 5000 - items: - type: - - object - - "null" - required: - - shipmentNumber - - orderNumber - - consignee - - shipDate - - statusCode - - status - - description - - manifestNumber - - shipperReference - - consigneeReference - - isMetric - - items - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - consignee: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: The consignee associated with the Shipment - shipDate: - description: The RFC 3339 scheduled ship date. - $ref: "#/components/schemas/ApolloDateV1" - statusCode: - description: TThe code indicating the status of the Order - type: integer - format: int32 - minLength: 1 - minimum: 1 - example: 8 - status: - description: The description of the status of the Order - type: - - string - - "null" - minLength: 1 - example: POSTED - description: - description: The description of the Order - type: - - string - - "null" - minLength: 1 - example: Lots of stuff - manifestNumber: - description: The unique Id to identify the Manifest - type: - - string - - "null" - minLength: 1 - example: M934567890 - shipperReference: - description: The reference provided by Shipper - type: - - string - - "null" - minLength: 1 - example: SHIPPER REF - consigneeReference: - description: The reference provided by Consignee - type: - - string - - "null" - minLength: 1 - example: CONSIGNEE REF - isMetric: - description: The flag indicating whether the measurements are metric - type: boolean - default: false + format: int32 + minLength: 1 + minimum: 1 + example: 10 + length: + description: Length of this item + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + width: + description: Width of this item + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + height: + description: Height of this item + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + weight: + description: Total weight of these items + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + additionalProperties: false + ApolloLabelV1: + description: | + An object representing the shipping label. + + | **labelFormat** | **Returned Containers** | + | :--: | :-- | + | DATA | labelFormat, labelData | + | PDF, PNG | labelFormat, labelImage | + type: object + required: + - labelFormat + - shipmentNumber + - orderNumber + - charges + properties: + labelFormat: + description: The output format for the label + type: + - string + - "null" + minLength: 1 + example: PDF + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + charges: + description: A collection of charges associated with this Order. Conditionally required based on payer of charges. + type: object + properties: + shipperCharges: + description: A collection of charges associated with this Order mapped to the shipper + type: + - array + - "null" items: - type: object - required: - - totalWeight - - weightUnit - - totalPieceCount - properties: - totalWeight: - description: The total weight of the Items in the Order - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 14 - weightUnit: - description: The tunits used to calculate weight + $ref: "#/components/schemas/ApolloChargeV1" + consigneeCharges: + description: A collection of charges associated with this Order mapped to the consignee + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloChargeV1" + thirdPartyCharges: + description: A collection of charges associated with this Order mapped to the third party + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloChargeV1" + additionalProperties: false + labelData: + type: object + required: + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + thirdParty: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + shipment: + type: object + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + description: The service type associated with the Order + type: + - string + - "null" + minLength: 1 + example: AM + paymentType: + description: The payment type associated with the Order + type: + - string + - "null" + minLength: 1 + example: PPD + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The pickup ready time. + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. + format: float + maximum: 999999.99 + minLength: 1 + minimum: 1 + example: 10 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + - LOOSE + orderDescription: + description: A short description of the Order + type: + - string + - "null" + minLength: 1 + example: WIDGETS + shipperReference: + description: A reference to the Order provided by Shipper + type: + - string + - "null" + minLength: 1 + example: ABC123 + consigneeReference: + description: A reference to the Order for the Consignee + type: + - string + - "null" + minLength: 1 + example: Z30010021 + currency: + description: The currency associated with the Order + type: + - string + - "null" + minLength: 3 + maxLength: 3 + example: USD + isMetric: + description: A flag indicating whether the units used are metric + type: + - string + - "null" + items: + description: AA collection of items + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloItemV1" + countryOfManufacture: + description: An unbounded array of country codes where the items originated + type: array + minItems: 1 + items: type: - string - "null" - enum: - - LB - totalPieceCount: - description: The total number of Pieces in the Order - type: integer - format: int32 - minimum: 1 minLength: 1 - example: 2 - item: - description: The unbounded array of individual items in the Order - type: array - minItems: 1 - items: + example: US + details: + description: The extra attributes that can be used in a label + $ref: "#/components/schemas/ApolloCustomArrayV1" + rates: + description: The cost associated with the Order to be printed in the label + type: object + properties: + amount: + $ref: "#/components/schemas/ApolloAmountV1" + currencyCode: type: - - object + - string - "null" - required: - - count - - length - - width - - height - - weight - properties: - count: - description: The number of components in the item - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 1 - length: - description: The length of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - width: - description: The width of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - height: - description: The height of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - weight: - description: The weight of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - additionalProperties: false - additionalProperties: false - additionalProperties: false - additionalProperties: true - - #/air/shipment - ApolloAirShipmentSubmitRequestV1: + description: The ISO 4217 currency code + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD + additionalProperties: false + sortCode: + description: The routing value to help the Ops Team + type: + - string + - "null" + minLength: 1 + example: U-BOS + gateway: + description: The airport gateway for routing + type: + - string + - "null" + minLength: 1 + example: "2" + count: + description: The total number of items in the order + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 2 + labelService: + description: The service entry used by the Ops Team + type: + - string + - "null" + minLength: 1 + example: ND + serviceDesc: + description: The description of the service + type: + - string + - "null" + minLength: 1 + example: UPS Next Day Air Freight - NGS + additionalProperties: false + additionalProperties: false + labelImage: + description: The byte array of the generated PDF represented as base64 string + type: + - string + - "null" + format: byte + example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: false + ApolloOrderNumberV1: + description: The Unique number used to identify the order + type: string + pattern: "^[0-9]{13}$" + example: "9100010270001" + ApolloPartyV1: type: object + description: Party information (shipper, consignee, or third party). required: - - account - - pickupDate + - city + - countryCode properties: + company: + type: string + description: Name of the company. + example: Philip account: - description: The Account Number that identifies the Shipper - type: - - string - - "null" - pickupDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" - requestManifest: - description: A flag indicating whether the manifest should be including in the response - type: boolean - default: false - manifestFormat: - description: The Output format for the manifest - type: - - string - - "null" + type: string + description: Account number associated with the party. + example: "987654321" + address1: + type: string + description: Primary address line. + example: 12380 MORRIS RD + address2: + type: string + description: Secondary address line. + example: Mailroom + address3: + type: string + description: Last address line. + example: Floor 1 + city: + type: string + description: City of the party. + example: Alpharetta + state: + type: string + description: The state code is required for country codes US or CA + minLength: 2 + maxLength: 2 + pattern: '^[A-Z]{2}' + example: GA + postalCode: + type: string + description: Postal code of the party. + example: "30005" + countryCode: + description: The ISO 3166 country or territory code. + $ref: "#/components/schemas/ApolloCountryCodeV1" + serviceCenterCode: + type: string + description: Service center code. + examples: + - SDF + - EWR + - ATL + partyCode: + type: string + description: Party code. + example: CID-987654321 + contactName: + type: string + description: Name of the contact person. + example: Michael + contactPhone: + type: string + description: Phone number of the contact person. + example: "999999999" + contactEmail: + type: string + description: Email address of the contact person. + pattern: '^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$' + example: test@gmail.com + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" additionalProperties: false - ApolloAirShipmentDataResponseV1: + ApolloPickupTotalV1: type: object required: - - account - - pickupDate - shipmentCount - - pieceCount - - weight - - weightUnit - - manifest + - itemCount + - totalWeight properties: - account: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - pickupDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" shipmentCount: - description: The count of all Shipments that are submitted for processing type: integer format: int32 minimum: 1 minLength: 1 - example: 2 - pieceCount: - description: The count of all peieces in all the shipments submitted + example: 10 + itemCount: type: integer format: int32 minimum: 1 minLength: 1 - example: 2 - weight: - description: The total weight of all the shipments + example: 10 + totalWeight: type: number - format: float + format: double minimum: 1 minLength: 1 - example: 2 - weightUnit: - description: The unit used to measure the weight - type: - - string - - "null" - manifest: - description: The manifest data that is returned if the format chosen is data - type: object - required: - - manifestNumber - - manifestFormat - - shipper - - shipments + example: 10 + additionalProperties: false + ApolloShipmentNumberV1: + type: + - string + - "null" + description: Unique identifier for the shipment. + minLength: 1 + examples: + - "9100010271" + ApolloShipmentPartyV1: + allOf: + - $ref: "#/components/schemas/ApolloShipmentAddressV1" + - type: object + description: Additional shipment party specific fields. All are optional. properties: - manifestNumber: - description: The unique number used to identify a manifest + account: type: - string - "null" - minLength: 1 - example: M934567890 - manifestFormat: - description: The output format of the manifest + maxLength : 9 + minLength : 6 + description: The unique UPS Freight Account Number associated with the Party. It's required when the party is the Shipper or Payor + example: 5503YY + serviceCenterCode: type: - string - "null" - minLength: 1 - example: PDF - shipper: - $ref: "#/components/schemas/ApolloShipmentAddressV1" - shipments: - description: An array of shipment details included in the manifest + maxLength : 5 + description: The service center that is associated with the Party. + example: SDF + contactName: type: - - array + - string - "null" - items: - type: - - object - - "null" - required: - - number - - shipmentNumber - - serviceType - - paymentType - - weight - - currency - - consignee - properties: - number: - description: The index of the shipment - type: integer - format: int32 - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - serviceType: - description: The service type used in the Shipment - type: - - string - - "null" - minLength: 1 - example: AM - paymentType: - description: The Payment type used in the shipment - type: - - string - - "null" - minLength: 1 - example: PPD - weight: - description: The total weight of the shipment - type: number - format: float - minLength: 1 - minimum: 1 - example: 10 - orderDescription: - description: A short description of the Order - type: - - string - - "null" - minLength: 1 - example: WIDGETS - currency: - description: The Acurrency used in the shipment - type: - - string - - "null" - minLength: 3 - maxLength: 3 - example: USD - shipperReference: - description: The reference provided by the shipper for the shipment - type: - - string - - "null" - minLength: 1 - example: ABC123 - consigneeReference: - description: The reference provided by the consignee for the shipment - type: - - string - - "null" - minLength: 1 - example: Z30010021 - consignee: - $ref: "#/components/schemas/ApolloShipmentAddressV1" - additionalProperties: false - summary: - type: object - required: - - services - - serviceTotal - - dailyPickupTotals - - currentPickupTotals - properties: - services: - description: The services used by the shipments and associated details - type: - - array - - "null" - items: - type: - - object - - "null" - required: - - shipmentCount - - itemCount - - totalWeight - - freightChargesAmount - - surchargesAmount - - addedChargesAmount - - billedAmount - - serviceCode - - serviceName - properties: - shipmentCount: - description: number of shipments using this service associated with this manifest - type: integer - format: int32 - minLength: 1 - minimum: 1 - example: 3 - itemCount: - description: The total number items in those shipments - type: integer - format: int32 - minLength: 1 - minimum: 1 - example: 3 - totalWeight: - description: The Atotal weight of those items - type: number - format: double - minLength: 1 - minimum: 1 - example: 3 - freightChargesAmount: - description: The total charges for this service - $ref: "#/components/schemas/ApolloAmountV1" - surchargesAmount: - description: The total surcharges for this service associated with this manifest - $ref: "#/components/schemas/ApolloAmountV1" - addedChargesAmount: - description: The total added charges for this service associated with this manifest - $ref: "#/components/schemas/ApolloAmountV1" - billedAmount: - description: Total Billed amount for this service - $ref: "#/components/schemas/ApolloAmountV1" - serviceCode: - description: The code for this service - type: - - string - - "null" - minLength: 1 - example: "01" - serviceName: - description: The name of the service - type: - - string - - "null" - minLength: 1 - example: "Next Day Air Early AM" - additionalProperties: false - serviceTotal: - type: object - description: The total for all services - required: - - shipmentCount - - itemCount - - totalWeight - - freightChargesAmount - - surchargesAmount - - addedChargesAmount - - billedAmount - properties: - shipmentCount: - description: The total number of shipments - type: integer - format: int32 - itemCount: - description: The total count of shipments - type: integer - format: int32 - totalWeight: - description: The total weight of shipments - type: number - format: double - freightChargesAmount: - description: total freight charges associated with the shipments in the manifest - type: number - format: double - surchargesAmount: - description: total surcharges associated with the shipments in the manifest - type: number - format: double - addedChargesAmount: - description: total added charges associated with the shipments in the manifest - type: number - format: double - billedAmount: - description: total billed charges associated with the shipments in the manifest - type: number - format: double - additionalProperties: false - dailyPickupTotals: - $ref: "#/components/schemas/ApolloPickupTotalV1" - currentPickupTotals: - $ref: "#/components/schemas/ApolloPickupTotalV1" - additionalProperties: false - additionalProperties: false - manifestNumber: - description: The unique number to identify the manifest + maxLength : 40 + description: The name of the person who can handle the communications related to the Shipment + example: John Doe + contactPhone: + type: + - string + - "null" + maxLength : 25 + description: The phone number of the person who can handle the communications related to the Shipment + example: 678-123-4567 + contactEmail: + type: + - string + - "null" + minLength: 1 + maxLength : 40 + description: The email of the person who can handle the communications related to the Shipment + example: john.doe@acme.com + details: + description: Any additional information related to the party in the format of key value pair + $ref: "#/components/schemas/ApolloCustomArrayV1" + unevaluatedProperties: false + ApolloShipmentAddressV1: + type: object + discriminator: + propertyName: operationId + mapping: + orderCreate: '#/components/schemas/ApolloOrderResponseV1' + orderSearch: '#/components/schemas/ApolloOrderSearchResponseV1' + printLabel: '#/components/schemas/ApolloLabelV1' + submitAirShipment: '#/components/schemas/ApolloAirShipmentDataResponseV1' + required: + - address1 + - city + - postalCode + - countryCode + properties: + operationId: + description: A string value to track this operation type: - string - "null" - minLength: 1 - example: M934567890 - manifestFormat: - description: The output format of the manifest + enum: + - orderCreate + - orderCancel + - orderSetDate + - orderSearch + - printLabel + - submitAirShipment + - cancelAirShipment + - printAirManifest + - airFreightRating + - getCity + partyCode: type: - string - "null" - minLength: 1 - example: PDF - manifestPDF: - description: The base64 string representing the byte array of the generated PDF + maxLength : 32 + description: The hashcode generated using the a Party's details, primaririly used to avoid duplicates + example: CID-987654321 + company: type: - string - "null" - format: byte - example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== - additionalProperties: false - ApolloAirShipmentCancelRequestV1: - type: object - required: - - shipperAccountNumber - - shipmentNumber - - language - properties: - shipperAccountNumber: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - language: - description: The language/culture that is being used for the API - type: string - minLength: 1 - maxLength: 6 - example: en-US - additionalProperties: false - ApolloAirShipmentCancelResponseV1: - type: object - required: - - shipperAccountNumber - - shipmentNumber - properties: - shipperAccountNumber: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - additionalProperties: false - - #/air/utility/city-details - ApolloGetCityResponseV1: - type: object - required: - - cityDetails - properties: - cityDetails: - description: The unbounded array representing the cities - type: array - minItems: 1 - items: - type: - - object - - "null" - required: - - stateProvinceCode - properties: - stateProvinceCode: - description: The State/Province to which the city belongs to - type: - - string - - "null" - minLength: 1 - example: GA - cityName: - description: The name of the city - type: - - string - - "null" - minLength: 1 - example: Alpharetta - majorAirportCity: - description: The nearest city with a major airport - type: - - string - - "null" - minLength: 1 - example: Atlanta - tariffDestination: - description: The destination used for billing purpose - type: - - string - - "null" - minLength: 1 - example: ATL - sortCode: - description: A value which helps the Ops team to route the package - type: - - string - - "null" - minLength: 1 - example: V1 - standardService: - description: The standard service offered in this city - type: - - string - - "null" - minLength: 1 - example: GND - additionalProperties: false - additionalProperties: false - - #/payment/status - ApolloPaymentPatchV1: + maxLength : 40 + description: The name of the company associated with the Shipment/Party + example: Ship To Philip + address1: + type: + - string + - "null" + maxLength : 40 + description: The line 1 of the address associated with the Party + example: 45678 MAIN ST + address2: + type: + - string + - "null" + description: The line 2 of the address associated with the Party + example: Suite 320 + address3: + type: + - string + - "null" + maxLength : 40 + description: The line 3 of the address associated with the Party + example: Floor 3 + city: + type: + - string + - "null" + maxLength : 40 + description: The address city associated with the Party + example: Newark + state: + type: + - string + - "null" + minLength: 2 + maxLength : 4 + pattern: ^[A-Z]{2} + description: The ISO 3166-2 state code associated with the Party + example: NJ + postalCode: + type: + - string + - "null" + maxLength : 15 + description: The line 2 of the address associated with the Party + example: 07102" + countryCode: + type: + - string + - "null" + minLength: 2 + maxLength : 4 + description: The ISO 3166 country or territory code associated with the Party + pattern: ^[A-Z]{2} + example: US + ApolloShipperAccountNumberV1: + description: The UPS Freight Account Number that identifies the Shipper + type: + - string + - "null" + minLength: 1 + example: "123456789" + ApolloTimeV1: + type: string + format: time + pattern: '^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$' + example: 09:00:00 + ApolloWeightV1: + type: number + format: decimal + multipleOf: 0.01 + ApolloPatchReplaceReqV1: type: array - description: Payload schema for payment record updates + description: The unbounded list of objects to change with their values + minItems: 1 items: type: object - description: API Request + required: + - op + - path + - value properties: op: - type: string - description: Operation type of the Patch + type: + - string + - "null" enum: - - add + - replace path: - type: string - description: Resource name - enum: - - /cardAuthStatus - - /paymentGUID + type: + - string + - "null" + description: the field whose value is to be changed + example: /newDate value: - oneOf: - - type: string - description: The status of the card authorization attempt. - oneOf: - - title: Success - const: '20001' - - title: Fail - const: '40001' - - type: string - description: The GUID reference of the payment transaction. This is conditionally required for cardAuthStatus of '20001'. - minLength: 32 - maxLength: 36 - pattern: ^[0-9a-fA-F]{8}[-]?([0-9a-fA-F]{4}[-]?){3}[0-9a-fA-F]{12}$ - example: 3437bfbe-fd57-4e50-9802-493b128c63e5 - additionalProperties: false - required: - - op - - path - - value - - #COMMON - ApolloAmountV1: - type: - - number - - "null" - format: double - examples: - - "10.00" - - waived - - included - ApolloChargeV1: + type: + - string + - "null" + description: new value to insert into the defined field + example: 2025-07-24 + additionalProperties: false + #Common Schemas for newly added APIs + + Charges: + type: object + description: Individual charge information. + properties: + chargeType: + type: string + description: Type of charge. + example: "Freight" + description: + type: string + description: Description of the charge. + example: "Freight Charge" + chargeAmount: + type: number + format: float + description: Amount of the charge. + example: 100.00 + currency: + type: string + description: Currency code for the charge. + example: "USD" + originalChargeAmount: + type: string + description: Original charge amount as string. + example: "100.00" + required: + - chargeType + - description + - chargeAmount + - currency + - originalChargeAmount + + #/air/ship + ApolloAirShipRequestV1: + type: object + required: [shipper, consignee, shipment] + properties: + shipper: + $ref: '#/components/schemas/PartyDetails' + consignee: + $ref: '#/components/schemas/PartyDetails' + thirdParty: + $ref: '#/components/schemas/PartyDetails' + description: ThirdParty details for the shipment. + nullable: true + type: [object, "null"] + shipment: + $ref: '#/components/schemas/ShipmentDetail' + label: + $ref: '#/components/schemas/LabelRequest' + description: Label formatting options including layout and format (e.g., PDF, ZPL, SVG). + nullable: true + type: [object, "null"] + language: + type: string + description: Language preference for the response. + example: "en" + transactionId: + type: string + description: Unique transaction ID for debugging and tracking. + example: "txn-001" + PartyDetails: + type: object + required: [account, address1, contactName, contactPhone, contactEmail, company, city, countryCode] + properties: + account: + type: string + description: UPS Freight Account Number associated with the party is required when the address is not provided. + example: "123456789" + address1: + type: string + description: The primary address line. + minLength: 1 + maxLength: 40 + example: "123 Main St" + address2: + type: string + description: The secondary address line. + maxLength: 40 + example: "Suite 100" + address3: + type: string + description: The last address line. + maxLength: 40 + example: "" + city: + type: string + description: City of the address. + minLength: 1 + maxLength: 30 + example: "New York" + state: + type: string + description: The state code is required for country codes US or CA. + maxLength: 5 + example: "NY" + postalCode: + type: string + description: Postal or ZIP code. + maxLength: 9 + example: "10001" + countryCode: + type: string + description: Two-letter country code (e.g., US, CA, GB). + minLength: 2 + maxLength: 2 + example: "US" + serviceCenterCode: + type: string + description: ServiceCenterCode of the party. + maxLength: 5 + example: "NYC" + partyCode: + type: string + description: PartyCode of the party. + maxLength: 40 + example: "SHIP123" + company: + type: string + description: CompanyName - The name of the company. + minLength: 1 + maxLength: 35 + example: "Shipper Inc" + contactName: + type: string + description: ContactName - The name of the contact person. + minLength: 1 + maxLength: 40 + example: "John Doe" + contactPhone: + type: string + description: ContactPhone - The phone number of the contact person. + minLength: 1 + maxLength: 25 + example: "+1-555-1234" + contactEmail: + type: string + description: Email - The email address of the contact person. + minLength: 1 + maxLength: 40 + pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ + example: "john.doe@shipper.com" + partySectionDetails: + type: object + additionalProperties: + type: string + description: Additional details as key-value pairs. + example: + department: "Logistics" + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + ShipmentDetail: type: object - required: - - code - - amount - - currencyCode + required: [serviceType, paymentType, pickupDate, items, currency, freightType] properties: - code: - description: The code used to identify the charge for classification and categorization - type: - - string - - "null" - minLength: 1 - example: AF + shipmentNumber: + type: string + description: Shipment number associated with the request. + example: "SHIP0001" + serviceType: + type: string + description: Type of the service requested (e.g., AM, AMG, D2, D2G, DF, DFG, CA, EC, CX). + enum: [AM, AMG, D2, D2G, DF, DFG, CA, EC, CX] + example: "AM" + paymentType: + type: string + description: Payment method used for the shipment (e.g., PPD, COL, THD). + enum: [PPD, COL, THD] + example: "PPD" + pickupDate: + type: string + format: date + description: Scheduled pickup date in YYYY-MM-DD format. + pattern: ^\d{4}-\d{2}-\d{2}$ + example: "2025-08-11" + readyTime: + type: string + description: Time when the shipment will be ready for pickup (HH:MM in 24-hour format). + pattern: ^([01]\d|2[0-3]):([0-5]\d)$ + example: "09:00" + closeTime: + type: string + description: Time when the shipment location will close (HH:MM in 24-hour format). + pattern: ^([01]\d|2[0-3]):([0-5]\d)$ + example: "17:00" + dropoffTime: + type: string + description: Time when the shipment will be dropped off (HH:MM in 24-hour format). + pattern: ^([01]\d|2[0-3]):([0-5]\d)$ + example: 16:00 + weight: + type: number + format: decimal + description: Total weight of the shipment. + minimum: 0.1 + maximum: 999.9 + example: 25.5 + freightType: + type: string + description: FreightType - This is freight type of the shipment piece. Possible values PALLET, LOOSE. + enum: [PALLET, LOOSE] + example: "PALLET" + isMetric: + type: boolean + description: Boolean value which indicates whether the shipment uses metric. + example: true description: - description: A short overview of the charge - type: - - string - - "null" - minLength: 1 - example: Air Freight - amount: - type: - - string - - "null" - description: Cost associated with the charge - examples: - - "10.00" - - waived - - included - currencyCode: - description: The ISO 4217 charge currency code - type: - - string - - "null" + type: string + description: Description of the shipment. + example: "Electronics shipment" + shipperReference: + type: string + description: Reference number provided by the shipper. + example: "REF123" + consigneeReference: + type: string + description: Reference number provided by the consignee. + example: "CREF456" + currency: + type: string + description: Currency code (e.g., USD, EUR). minLength: 3 maxLength: 3 - pattern: ^[A-Z]{3} - example: USD - includedInd: - type: - - string - - "null" - additionalProperties: false - ApolloCountryCodeV1: - type: string - minLength: 2 - maxLength: 2 - pattern: '^[A-Z]{2}' - example: US - ApolloCustomArrayV1: - type: array - description: Unbounded array of additional key-value pair objects - minItems: 1 - items: - type: object - description: key-value pair object - properties: - key: - type: string - description: the name referencing the paired object - minLength: 1 - example: HAZMAT - value: + example: "USD" + requestPickup: + type: boolean + description: Boolean value which indicates whether a pickup request is included. + example: true + requestBoL: + type: boolean + description: Boolean value which Indicates whether a Bill of Lading (BoL) is requested. + example: false + countryOfManufacture: + type: array + items: type: string - description: the value referencing the paired object - minLength: 1 - example: "true" - additionalProperties: false - ApolloDateV1: - type: string - format: date - example: 2025-05-13 - ApolloDateTimeV1: - type: string - format: date-time - example: 2025-05-13 05:00:00 - ApolloDimensionV1: - type: number - format: float - minimum: 0.1 - maximum: 999.9 - examples: - - 15 - - 6.84 - ApolloErrorResponseV1: - type: object - description: Response object for errors - properties: - response: - type: object - description: Response container to store errors - properties: - errors: - type: array - description: Unbounded array containing one or more error objects - minItems: 1 - items: - type: object - description: Error entity - properties: - code: - type: string - description: error code - minLength: 1 - example: "250002" - message: - type: string - description: error message - minLength: 1 - example: Invalid Authentication Information. - required: - - code - - message - additionalProperties: false - required: - - errors - additionalProperties: false - required: - - response - additionalProperties: false - ApolloItemV1: + minLength: 2 + maxLength: 2 + description: List of countries where the goods were manufactured. + example: ["US"] + items: + type: array + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/Item' + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + Item: type: object - required: - - itemDescription - - count - - length - - width - - height - - weight + required: [count, length, width, height, weight] properties: - itemDescription: - description: A short description of the item - type: - - string - - "null" + description: + type: string + description: The description of the item. + maxLength: 50 + example: "Laptop" count: - description: A total number of this item - type: - - integer - - "null" - format: int32 - minLength: 1 + type: integer + description: Number of identical items in the shipment. minimum: 1 + maximum: 99999 example: 10 length: - description: Length of this item type: number - format: float - minLength: 1 - minimum: 1 - example: 10 + format: decimal + description: Length of the shipment item in centimeters. + minimum: 0 + maximum: 999.9 + example: 38.5 width: - description: Width of this item type: number - format: float - minLength: 1 - minimum: 1 - example: 10 + format: decimal + description: Width of the shipment item in centimeters. + minimum: 0 + maximum: 999.9 + example: 25.0 height: - description: Height of this item type: number - format: float - minLength: 1 - minimum: 1 - example: 10 + format: decimal + description: Height of the shipment item in centimeters. + minimum: 0.1 + maximum: 999.9 + example: 2.5 weight: - description: Total weight of these items type: number - format: float - minLength: 1 - minimum: 1 - example: 10 - additionalProperties: false - ApolloLabelV1: - description: | - An object representing the shipping label. - - | **labelFormat** | **Returned Containers** | - | :--: | :-- | - | DATA | labelFormat, labelData | - | PDF, PNG | labelFormat, labelImage | + format: decimal + description: Weight of the shipment item in kilograms. + minimum: 0 + maximum: 999.9 + example: 2.0 + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + LabelRequest: + type: object + properties: + layout: + type: string + description: The layout type for the label (e.g., AF-GEMINI, AF-UFH). + example: "AF-GEMINI" + format: + type: string + description: The output format for the label (e.g., PDF, ZPL, SVG). + example: "PDF" + details: + type: object + additionalProperties: + type: string + description: A list of label detail fields and values. + example: + Model_Number: "X" + Model_Year: "2023" + Shipper_ReferenceNo: "SHP2401-A3MC220" + ApolloAirShipResponseV1: + type: object + required: + - response + properties: + response: + type: object + shipmentNumber: + type: string + description: The shipment number associated with the response. + example: "SHIP0001" + prqNumber: + type: string + description: The PRQ details associated with the shipment. + example: "PRQ123456" + prqStatus: + type: string + description: The shipment status. + example: "CONFIRMED" + originServiceCenter: + type: string + description: The origin service center code. + example: "NYC" + destinationServiceCenter: + type: string + description: The destination service center code. + example: "SFO" + paymentType: + type: string + description: The payment type for the shipment. + example: "PPD" + rates: + type: array + items: + $ref: '#/components/schemas/RateDetail' + label: + $ref: '#/components/schemas/LabelResponse' + RateDetail: + type: object + properties: + serviceType: + type: string + description: The type of service. + example: "AM" + guaranteedDelivery: + type: boolean + description: Indicates if delivery is guaranteed. + example: true + deliveryTime: + type: string + description: The estimated delivery time. + example: "2025-08-12T10:00:00Z" + holdAtAirportTime: + type: string + description: The hold at airport time. + example: "2025-08-12T12:00:00Z" + totalCharge: + type: number + format: decimal + description: The total charge for the service. + example: 150.75 + currency: + type: string + description: The currency type. + example: "USD" + billableWeight: + type: number + format: decimal + description: The billable weight. + example: 30.0 + weightUnit: + type: string + description: The Weight unit used. + example: "KG" + dimensionalWeight: + type: number + format: decimal + description: The dimensional weight. + example: 28.0 + minimumBillableWeightApplied: + type: boolean + description: Indicates if the minimum billable weight was applied. + example: false + contractRate: + type: boolean + description: Indicates if the contract rate applies. + example: false + charges: + type: array + items: + $ref: '#/components/schemas/Charges' + LabelResponse: + type: object + properties: + format: + type: string + description: The format of the label. + example: "PDF" + layout: + type: string + description: The layout of the label. + example: "4x6" + labelT: + type: string + description: The label text (Base64 encoded). + example: "Base64EncodedLabelString" + image: + type: string + format: byte + description: The label in PDF format (Base64 encoded). + example: "Base64EncodedPDF" + + + + ApolloUtilityAirportDetailResponseV1: type: object - required: - - labelFormat - - shipmentNumber - - orderNumber - - charges + description: Response containing a collection of airport details. properties: - labelFormat: - description: The output format for the label - type: - - string - - "null" - minLength: 1 - example: PDF - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - charges: - description: A collection of charges associated with this Order. Conditionally required based on payer of charges. + response: type: object + description: Response wrapper object. properties: - shipperCharges: - description: A collection of charges associated with this Order mapped to the shipper - type: - - array - - "null" - items: - $ref: "#/components/schemas/ApolloChargeV1" - consigneeCharges: - description: A collection of charges associated with this Order mapped to the consignee - type: - - array - - "null" - items: - $ref: "#/components/schemas/ApolloChargeV1" - thirdPartyCharges: - description: A collection of charges associated with this Order mapped to the third party - type: - - array - - "null" + airportDetails: + type: array + description: List of airport details. items: - $ref: "#/components/schemas/ApolloChargeV1" - additionalProperties: false - labelData: - type: object + $ref: "#/components/schemas/ApolloAirportResponseDetailsV1" required: - - shipper - - consignee - - shipment - properties: - shipper: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - consignee: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - thirdParty: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - shipment: - type: object - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - serviceType: - description: The service type associated with the Order - type: - - string - - "null" - minLength: 1 - example: AM - paymentType: - description: The payment type associated with the Order - type: - - string - - "null" - minLength: 1 - example: PPD - pickupDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" - readyTime: - description: The pickup ready time. - $ref: "#/components/schemas/ApolloTimeV1" - closeTime: - description: The location close time. - $ref: "#/components/schemas/ApolloTimeV1" - dropoffTime: - description: The shipment dropoff time. - $ref: "#/components/schemas/ApolloTimeV1" - weight: - type: number - description: Total weight of the shipment. - format: float - maximum: 999999.99 - minLength: 1 - minimum: 1 - example: 10 - freightType: - type: string - description: Freight type of the shipment. - enum: - - PALLET - - LOOSE - orderDescription: - description: A short description of the Order - type: - - string - - "null" - minLength: 1 - example: WIDGETS - shipperReference: - description: A reference to the Order provided by Shipper - type: - - string - - "null" - minLength: 1 - example: ABC123 - consigneeReference: - description: A reference to the Order for the Consignee - type: - - string - - "null" - minLength: 1 - example: Z30010021 - currency: - description: The currency associated with the Order - type: - - string - - "null" - minLength: 3 - maxLength: 3 - example: USD - isMetric: - description: A flag indicating whether the units used are metric - type: - - string - - "null" - items: - description: AA collection of items - type: - - array - - "null" - items: - $ref: "#/components/schemas/ApolloItemV1" - countryOfManufacture: - description: An unbounded array of country codes where the items originated - type: array - minItems: 1 - items: - type: - - string - - "null" - minLength: 1 - example: US - details: - description: The extra attributes that can be used in a label - $ref: "#/components/schemas/ApolloCustomArrayV1" - rates: - description: The cost associated with the Order to be printed in the label - type: object - properties: - amount: - $ref: "#/components/schemas/ApolloAmountV1" - currencyCode: - type: - - string - - "null" - description: The ISO 4217 currency code - minLength: 3 - maxLength: 3 - pattern: ^[A-Z]{3} - example: USD - additionalProperties: false - sortCode: - description: The routing value to help the Ops Team - type: - - string - - "null" - minLength: 1 - example: U-BOS - gateway: - description: The airport gateway for routing - type: - - string - - "null" - minLength: 1 - example: "2" - count: - description: The total number of items in the order - type: integer - format: int32 - minLength: 1 - minimum: 1 - example: 2 - labelService: - description: The service entry used by the Ops Team - type: - - string - - "null" - minLength: 1 - example: ND - serviceDesc: - description: The description of the service - type: - - string - - "null" - minLength: 1 - example: UPS Next Day Air Freight - NGS - additionalProperties: false - additionalProperties: false - labelImage: - description: The byte array of the generated PDF represented as base64 string - type: - - string - - "null" - format: byte - example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== - additionalProperties: false - ApolloOrderNumberV1: - description: The Unique number used to identify the order - type: string - minLength: 1 - example: "9100010270001" - ApolloPartyV1: - type: object - description: Party information (shipper, consignee, or third party). + - airportDetails required: - - city - - countryCode + - response + + ApolloAirportResponseDetailsV1: + type: object properties: - company: + city: type: string - description: Name of the company. - example: Philip - account: + description: City where the airport is located. + example: "New York" + airportCode: type: string - description: Account number associated with the party. - example: "987654321" - address1: + description: Unique code identifying the airport. + example: "JFK" + postalCode: type: string - description: Primary address line. - example: 12380 MORRIS RD - address2: + description: Postal code associated with the airport's location. + example: "11430" + stateProvince: + type: string + description: State or province of the airport's location. + example: "NY" + + CountryCodeResponseV1: + type: object + properties: + countries: + type: array + description: List of countries + items: + $ref: "#/components/schemas/CountryCodeV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + CountryCodeV1: + type: object + properties: + countryCode: + type: string + description: ISO 3166-1 alpha-2 country code + countryName: + type: string + description: Name of the country + + PaymentTermInfoV1: + type: object + properties: + code: type: string - description: Secondary address line. - example: Mailroom - address3: + description: Payment type code + type: type: string - description: Tertiary address line. - example: Floor 1 - city: + description: Type of the payment term + description: type: string - description: City of the party. - example: Alpharetta - state: + description: Description of the payment term + incoTermCode: type: string - description: The ISO 3166-2 country or territory code. - minLength: 2 - maxLength: 2 - pattern: '^[A-Z]{2}' - example: GA - postalCode: + description: Incoterm code + movementTypeCode: type: string - description: Postal code of the party. - example: "30005" - countryCode: - description: The ISO 3166 country or territory code. - $ref: "#/components/schemas/ApolloCountryCodeV1" - serviceCenterCode: + description: Movement type code + serviceGroupName: type: string - description: Service center code. - examples: - - SDF - - EWR - - ATL - partyCode: + description: Name of the service group + serviceLine: type: string - description: Party code. - example: CID-987654321 - contactName: + description: Service line code + + PaymentTypeResponseV1: + type: object + properties: + shipper: + $ref: "#/components/schemas/PaymentTermInfoV1" + consignee: + $ref: "#/components/schemas/PaymentTermInfoV1" + thirdParty: + $ref: "#/components/schemas/PaymentTermInfoV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: type: string - description: Name of the contact person. - example: Michael - contactPhone: + + CurrenciesResponseV1: + type: object + properties: + currencies: + type: array + description: List of currencies + items: + $ref: "#/components/schemas/CurrencyDataV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: type: string - description: Phone number of the contact person. - example: "999999999" - contactEmail: + + CurrencyDataV1: + type: object + properties: + currencyCode: type: string - description: Email address of the contact person. - pattern: '^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$' - example: test@gmail.com - details: - description: Additional details about the party as key-value pairs. - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false - ApolloPickupTotalV1: + description: Currency code + currencyName: + type: string + description: Currency name + currencySymbol: + type: string + description: Currency symbol + + #/utility/servicetypes/search + ServiceTypeSearchResponseV1: type: object - required: - - shipmentCount - - itemCount - - totalWeight + description: Response containing service types. properties: - shipmentCount: - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 10 - itemCount: - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 10 - totalWeight: - type: number - format: double - minimum: 1 - minLength: 1 - example: 10 - additionalProperties: false - ApolloShipmentNumberV1: - type: - - string - - "null" - description: Unique identifier for the shipment. - minLength: 1 - examples: - - "9100010271" - ApolloShipmentPartyV1: - allOf: - - $ref: "#/components/schemas/ApolloShipmentAddressV1" - - type: object - description: Additional shipment party specific fields. All are optional. + response: + type: object + description: Response containing a list of serviceTypes. properties: - account: - type: - - string - - "null" - maxLength : 9 - minLength : 6 - description: The unique Account Number associated with the Party - example: 5503YY - serviceCenterCode: - type: - - string - - "null" - maxLength : 5 - description: The service center that is associated with the Party - example: SDF - contactName: - type: - - string - - "null" - maxLength : 40 - description: The name of the person who can handle the communications related to the Shipment - example: John Doe - contactPhone: - type: - - string - - "null" - maxLength : 25 - description: The phone number of the person who can handle the communications related to the Shipment - example: 678-123-4567 - contactEmail: - type: - - string - - "null" - minLength: 1 - maxLength : 40 - description: The email of the person who can handle the communications related to the Shipment - example: john.doe@acme.com - details: - description: Any additional information related to the party in the format of key value pair - $ref: "#/components/schemas/ApolloCustomArrayV1" - unevaluatedProperties: false - ApolloShipmentAddressV1: - type: object - discriminator: - propertyName: operationId - mapping: - orderCreate: '#/components/schemas/ApolloOrderResponseV1' - orderSearch: '#/components/schemas/ApolloOrderSearchResponseV1' - printLabel: '#/components/schemas/ApolloLabelV1' - submitAirShipment: '#/components/schemas/ApolloAirShipmentDataResponseV1' + serviceTypes: + type: array + description: List of available service types. + items: + $ref: "#/components/schemas/ServiceTypeInfo" + required: + - serviceTypes required: - - address1 - - city - - postalCode - - countryCode + - response + + ServiceTypeInfo: + type: object + description: Service type information. properties: - operationId: - description: A string value to track this operation - type: - - string - - "null" - enum: - - orderCreate - - orderCancel - - orderPostpone - - orderSearch - - printLabel - - submitAirShipment - - cancelAirShipment - - printAirManifest - - airFreightRating - - getCity - partyCode: - type: - - string - - "null" - maxLength : 32 - description: The hashcode generated using the a Party's details, primaririly used to avoid duplicates - example: CID-987654321 - company: - type: - - string - - "null" - maxLength : 40 - description: The name of the company associated with the Shipment/Party - example: Ship To Philip - address1: - type: - - string - - "null" - maxLength : 40 - description: The line 1 of the address associated with the Party - example: 45678 MAIN ST - address2: - type: - - string - - "null" - description: The line 2 of the address associated with the Party - example: Suite 320 - address3: - type: - - string - - "null" - maxLength : 40 - description: The line 3 of the address associated with the Party - example: Floor 3 - city: - type: - - string - - "null" - maxLength : 40 - description: The address city associated with the Party - example: Newark - state: - type: - - string - - "null" - minLength: 2 - maxLength : 4 - pattern: ^[A-Z]{2} - description: The ISO 3166-2 state code associated with the Party - example: NJ - postalCode: - type: - - string - - "null" - maxLength : 15 - description: The line 2 of the address associated with the Party - example: 07102" - countryCode: - type: - - string - - "null" - minLength: 2 - maxLength : 4 - description: The ISO 3166 country or territory code associated with the Party - pattern: ^[A-Z]{2} - example: US - ApolloShipperAccountNumberV1: - description: The Account Number that identifies the Shipper - type: - - string - - "null" - minLength: 1 - example: 4492YY - ApolloTimeV1: - type: string - format: time - pattern: '^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$' - example: 09:00:00 - ApolloWeightV1: - type: number - format: decimal - multipleOf: 0.01 \ No newline at end of file + code: + type: string + description: Code for the service type. + example: "AIR" + description: + type: string + description: Description of the service type. + example: "Air Freight" + required: + - code + - description From b31e2ab543eea3544d827ecfcc3da114aabc9ede Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 7 Nov 2025 15:16:36 -0500 Subject: [PATCH 18/89] Update (#194) --- Forwarding.yaml | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index bfa24b0..598b213 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -5,7 +5,7 @@ info: description: | Links the UPS Forarding Hub to backend applications for the management of ocean and air freight shipments. - **Key Business Values:** + # Key Business Values - UPS Forwarding Hub APIs unify ocean and air freight through a single, modern RESTful interface. - They accelerate time to market with simplified, scalable integration. - Real-time rate quotes and booking enhance the customer experience. @@ -13,6 +13,10 @@ info: - Streamlined documentation and developer support reduce onboarding time NOTE: Please contact for GUID support + + # Reference + - Errors + servers: - url: https://www.onlinetools.ups.com/api/forwarding/{version} description: URL for OAuth based authentication that can be used for the UPS Production environment. @@ -51,7 +55,7 @@ paths: description: Generate estimated freight charges based on the provided origin, destination, payor information, and cargo details. operationId: freightRating tags: - - Shipments + - Forwarding parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -306,7 +310,7 @@ paths: - $ref: "#/components/parameters/X-BusinessGUID" - $ref: "#/components/parameters/X-ClientId" tags: - - Orders + - Forwarding requestBody: required: true description: Container for shipment & package details to be made into an order. @@ -1208,7 +1212,7 @@ paths: summary: Re-Print label operationId: printLabel tags: - - Documents + - Forwarding description: Re-Print label for an existing Order parameters: - $ref: "#/components/parameters/transId" @@ -1473,7 +1477,7 @@ paths: summary: Processes all shipments operationId: submitAirShipment tags: - - Shipments + - Forwarding description: Processes all shipments created for a specific shipper during the day and returns a manifest. parameters: - $ref: "#/components/parameters/transId" @@ -2139,7 +2143,7 @@ paths: summary: Print Air Manifest operationId: printAirManifest tags: - - Documents + - Forwarding description: Generates and returns the manifest for the specified manifest number in the requested format. parameters: - $ref: "#/components/parameters/transId" @@ -2391,8 +2395,8 @@ paths: get: operationId: getCity tags: - - Info - summary: citydata. + - Forwarding + summary: City Data. description: Retrieves city details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -2577,8 +2581,8 @@ paths: get: operationId: getCurrencies tags: - - Info - summary: retrieves currencies. + - Forwarding + summary: Retrieves Currencies. description: Retrieves the currency details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -2736,7 +2740,7 @@ paths: get: operationId: getAirPaymentTypes tags: - - Info + - Forwarding summary: get payment types. description: Retrieves payment types matching the provided search criteria. parameters: @@ -2938,8 +2942,8 @@ paths: get: operationId: getCountries tags: - - Info - summary: country data. + - Forwarding + summary: Country Data. description: Retrieves country details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -3099,7 +3103,7 @@ paths: description: Retrieve airport details by country code. operationId: getAirportDetails tags: - - Info + - Forwarding parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -3228,7 +3232,7 @@ paths: description: Retrieves available service types based on shipper and consignee information. operationId: getServiceTypes tags: - - Info + - Forwarding parameters: - $ref: "#/components/parameters/shipper_city" - $ref: "#/components/parameters/shipper_state_code" From 271a9967a0757beab12b1ff0b8cc7de932ac59b5 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 7 Nov 2025 16:05:46 -0500 Subject: [PATCH 19/89] Update update --- mainspec1.yaml | 246 ------------------------------------------------- mainspec2.yaml | 217 ------------------------------------------- mainspec3.yaml | 190 -------------------------------------- mainspec4.yaml | 206 ----------------------------------------- mainspec5.yaml | 177 ----------------------------------- mainspec6.yaml | 229 --------------------------------------------- mainspec7.yaml | 239 ----------------------------------------------- 7 files changed, 1504 deletions(-) delete mode 100644 mainspec1.yaml delete mode 100644 mainspec2.yaml delete mode 100644 mainspec3.yaml delete mode 100644 mainspec4.yaml delete mode 100644 mainspec5.yaml delete mode 100644 mainspec6.yaml delete mode 100644 mainspec7.yaml diff --git a/mainspec1.yaml b/mainspec1.yaml deleted file mode 100644 index 91857e2..0000000 --- a/mainspec1.yaml +++ /dev/null @@ -1,246 +0,0 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced.yaml#/info/description" - - name: Delivery Defense - description: - $ref: "DeliveryDefense.yaml#/info/description" - - name: Delivery Intercept - description: - $ref: "DeliveryIntercept.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Commerce Guard - description: - $ref: "CommerceGuard.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - - name: Forwarding - description: - $ref: "Forwarding.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/forwarding/{version}/air/rate": - "$ref": "Forwarding.yaml#/paths/~1air~1rate" - "/forwarding/{version}/air/orders": - "$ref": "Forwarding.yaml#/paths/~1air~1orders" - "/forwarding/{version}/air/orders/print-label": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" - "/forwarding/{version}/air/orders/postpone": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" - "/forwarding/{version}/air/orders/search": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" - "/forwarding/{version}/air/shipment": - "$ref": "Forwarding.yaml#/paths/~1air~1shipment" - "/forwarding/{version}/air/utility/city-details": - "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" - "/forwarding/{version}/payment/status/{session_id}": - "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/deliveryintercept/{version}/charges/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" - "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" - "/deliveryintercept/{version}/redirect/address/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" - "/deliveryintercept/{version}/willcall/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" - "/deliveryintercept/{version}/return/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" - "/deliveryintercept/{version}/reschedule/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" - "/deliveryintercept/{version}/cancel/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" - "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" - "/commerce-guard/{version}/verify": - "$ref": "CommerceGuard.yaml#/paths/~1commerce-guard~1{version}~1verify" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec2.yaml b/mainspec2.yaml deleted file mode 100644 index 78feeec..0000000 --- a/mainspec2.yaml +++ /dev/null @@ -1,217 +0,0 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - - name: Forwarding - description: - $ref: "Forwarding.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/forwarding/{version}/air/rate": - "$ref": "Forwarding.yaml#/paths/~1air~1rate" - "/forwarding/{version}/air/orders": - "$ref": "Forwarding.yaml#/paths/~1air~1orders" - "/forwarding/{version}/air/orders/print-label": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" - "/forwarding/{version}/air/orders/postpone": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" - "/forwarding/{version}/air/orders/search": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" - "/forwarding/{version}/air/shipment": - "$ref": "Forwarding.yaml#/paths/~1air~1shipment" - "/forwarding/{version}/air/utility/city-details": - "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" - "/forwarding/{version}/payment/status/{session_id}": - "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec3.yaml b/mainspec3.yaml deleted file mode 100644 index 3ee4f9b..0000000 --- a/mainspec3.yaml +++ /dev/null @@ -1,190 +0,0 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - - name: Forwarding - description: - $ref: "Forwarding.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/forwarding/{version}/air/rate": - "$ref": "Forwarding.yaml#/paths/~1air~1rate" - "/forwarding/{version}/air/orders": - "$ref": "Forwarding.yaml#/paths/~1air~1orders" - "/forwarding/{version}/air/orders/print-label": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" - "/forwarding/{version}/air/orders/postpone": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" - "/forwarding/{version}/air/orders/search": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" - "/forwarding/{version}/air/shipment": - "$ref": "Forwarding.yaml#/paths/~1air~1shipment" - "/forwarding/{version}/air/utility/city-details": - "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" - "/forwarding/{version}/payment/status/{session_id}": - "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec4.yaml b/mainspec4.yaml deleted file mode 100644 index 81ad5bb..0000000 --- a/mainspec4.yaml +++ /dev/null @@ -1,206 +0,0 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert-Ready.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation-Ready.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods-Ready.yaml#/info/description" - - name: Forwarding - description: - $ref: "Forwarding.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost-Ready.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode-Ready.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials-Ready.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless-Ready.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification-Ready.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView-Ready.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking-Ready.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/forwarding/{version}/air/rate": - "$ref": "Forwarding.yaml#/paths/~1air~1rate" - "/forwarding/{version}/air/orders": - "$ref": "Forwarding.yaml#/paths/~1air~1orders" - "/forwarding/{version}/air/orders/print-label": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" - "/forwarding/{version}/air/orders/postpone": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" - "/forwarding/{version}/air/orders/search": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" - "/forwarding/{version}/air/shipment": - "$ref": "Forwarding.yaml#/paths/~1air~1shipment" - "/forwarding/{version}/air/utility/city-details": - "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" - "/forwarding/{version}/payment/status/{session_id}": - "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" - "/landedcost/{version}/quotes": - "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec5.yaml b/mainspec5.yaml deleted file mode 100644 index 13b5965..0000000 --- a/mainspec5.yaml +++ /dev/null @@ -1,177 +0,0 @@ -openapi: 3.1.0 -info: - title: '' - description: ' ' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: Address Validation - description: - $ref: "AddressValidation-Ready.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods-Ready.yaml#/info/description" - - name: Forwarding - description: - $ref: "Forwarding.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost-Ready.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode-Ready.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials-Ready.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless-Ready.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification-Ready.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView-Ready.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking-Ready.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/forwarding/{version}/air/rate": - "$ref": "Forwarding.yaml#/paths/~1air~1rate" - "/forwarding/{version}/air/orders": - "$ref": "Forwarding.yaml#/paths/~1air~1orders" - "/forwarding/{version}/air/orders/print-label": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" - "/forwarding/{version}/air/orders/postpone": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" - "/forwarding/{version}/air/orders/search": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" - "/forwarding/{version}/air/shipment": - "$ref": "Forwarding.yaml#/paths/~1air~1shipment" - "/forwarding/{version}/air/utility/city-details": - "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" - "/forwarding/{version}/payment/status/{session_id}": - "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" - "/landedcost/{version}/quotes": - "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec6.yaml b/mainspec6.yaml deleted file mode 100644 index 061e1a7..0000000 --- a/mainspec6.yaml +++ /dev/null @@ -1,229 +0,0 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert-Ready.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced-Ready.yaml#/info/description" - - name: Delivery Defense - description: - $ref: "DeliveryDefense-Ready.yaml#/info/description" - - name: Delivery Intercept - description: - $ref: "DeliveryIntercept.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation-Ready.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods-Ready.yaml#/info/description" - - name: Forwarding - description: - $ref: "Forwarding.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost-Ready.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode-Ready.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials-Ready.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless-Ready.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification-Ready.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView-Ready.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking-Ready.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation-Ready.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/forwarding/{version}/air/rate": - "$ref": "Forwarding.yaml#/paths/~1air~1rate" - "/forwarding/{version}/air/orders": - "$ref": "Forwarding.yaml#/paths/~1air~1orders" - "/forwarding/{version}/air/orders/print-label": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" - "/forwarding/{version}/air/orders/postpone": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" - "/forwarding/{version}/air/orders/search": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" - "/forwarding/{version}/air/shipment": - "$ref": "Forwarding.yaml#/paths/~1air~1shipment" - "/forwarding/{version}/air/utility/city-details": - "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" - "/forwarding/{version}/payment/status/{session_id}": - "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" - "/landedcost/{version}/quotes": - "$ref": "LandedCost-Ready.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode-Ready.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials-Ready.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless-Ready.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification-Ready.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView-Ready.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking-Ready.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/deliveryintercept/{version}/charges/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" - "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" - "/deliveryintercept/{version}/redirect/address/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" - "/deliveryintercept/{version}/willcall/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" - "/deliveryintercept/{version}/return/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" - "/deliveryintercept/{version}/reschedule/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" - "/deliveryintercept/{version}/cancel/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" - "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense-Ready.yaml#/paths/~1address~1score" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - #"/brokerage/{version}/content/glc/request-quote": - # "$ref": "GlobalCheckout.yaml#/paths/~1content~1glc~1request-quote" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert-Ready.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert-Ready.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced-Ready.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation-Ready.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials-Ready.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - - $ref: 'OAuthAuthCode-Ready.yaml#/components/securitySchemes/BasicAuthRefresh' diff --git a/mainspec7.yaml b/mainspec7.yaml deleted file mode 100644 index c319fd9..0000000 --- a/mainspec7.yaml +++ /dev/null @@ -1,239 +0,0 @@ -openapi: 3.1.0 -info: - title: '' - description: '' - version: '' -servers: - - url: https://wwwcie.ups.com/api - description: Customer Integration Environment - - url: https://onlinetools.ups.com/api - description: Production -tags: - - name: UPS Track Alert - description: - $ref: "UPSTrackAlert.yaml#/info/description" - - name: UPS Track Alert with Photo - description: - $ref: "UPSTrackAlertEnhanced.yaml#/info/description" - - name: Delivery Defense - description: - $ref: "DeliveryDefense.yaml#/info/description" - - name: Delivery Intercept - description: - $ref: "DeliveryIntercept.yaml#/info/description" - - name: Export Assure - description: - $ref: "UPSExportAssure.yaml#/info/description" - - name: Interactive Description - description: - $ref: "InteractiveDescriptionGuidance.yaml#/info/description" - - name: Address Validation - description: - $ref: "AddressValidation.yaml#/info/description" - - name: Dangerous Goods - description: - $ref: "DangerousGoods.yaml#/info/description" - - name: Forwarding - description: - $ref: "Forwarding.yaml#/info/description" - #- name: Global Checkout - # description: - # $ref: "GlobalCheckout.yaml#/info/description" - - name: Landed Cost - description: - $ref: "LandedCost.yaml#/info/description" - - name: Locator - description: - $ref: "Locator.yaml#/info/description" - - name: OAuth Auth Code - description: - $ref: "OAuthAuthCode.yaml#/info/description" - - name: OAuth Client Credentials - description: - $ref: "OAuthClientCredentials.yaml#/info/description" - - name: Paperless - description: - $ref: "Paperless.yaml#/info/description" - - name: Pickup - description: - $ref: "Pickup.yaml#/info/description" - - name: Pre-Notification - description: - $ref: "PreNotification.yaml#/info/description" - - name: Quantum View - description: - $ref: "QuantumView.yaml#/info/description" - - name: Rating - description: - $ref: "Rating.yaml#/info/description" - - name: Shipping - description: - $ref: "Shipping.yaml#/info/description" - - name: TradeDirect - description: - $ref: "TradeDirect.yaml#/info/description" - - name: Time in Transit - description: - $ref: "TimeInTransit.yaml#/info/description" - - name: Tracking - description: - $ref: "Tracking.yaml#/info/description" - - name: World Ease Shipment Management - Shipment - description: - $ref: "WorldEaseShipmentManagement.yaml#/info/description" -paths: - "/addressvalidation/{version}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{version}~1{requestoption}" - "/addressvalidation/{deprecatedVersion}/{requestoption}": - "$ref": "AddressValidation.yaml#/paths/~1addressvalidation~1{deprecatedVersion}~1{requestoption}" - "/dangerousgoods/{version}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1chemicalreferencedata" - "/dangerousgoods/{version}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{version}~1acceptanceauditprecheck" - "/dangerousgoods/{deprecatedVersion}/chemicalreferencedata": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1chemicalreferencedata" - "/dangerousgoods/{deprecatedVersion}/acceptanceauditprecheck": - "$ref": "DangerousGoods.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1acceptanceauditprecheck" - "/forwarding/{version}/air/rate": - "$ref": "Forwarding.yaml#/paths/~1air~1rate" - "/forwarding/{version}/air/orders": - "$ref": "Forwarding.yaml#/paths/~1air~1orders" - "/forwarding/{version}/air/orders/print-label": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1print-label" - "/forwarding/{version}/air/orders/postpone": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1postpone" - "/forwarding/{version}/air/orders/search": - "$ref": "Forwarding.yaml#/paths/~1air~1orders~1search" - "/forwarding/{version}/air/shipment": - "$ref": "Forwarding.yaml#/paths/~1air~1shipment" - "/forwarding/{version}/air/utility/city-details": - "$ref": "Forwarding.yaml#/paths/~1air~1utility~1city-details" - "/forwarding/{version}/payment/status/{session_id}": - "$ref": "Forwarding.yaml#/paths/~1payment~1status~1{session_id}" - "/landedcost/{version}/quotes": - "$ref": "LandedCost.yaml#/paths/~1landedcost~1{version}~1quotes" - "/locations/{version}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{version}~1search~1availabilities~1{reqOption}" - "/locations/{deprecatedVersion}/search/availabilities/{reqOption}": - "$ref": "Locator.yaml#/paths/~1locations~1{deprecatedVersion}~1search~1availabilities~1{reqOption}" - "/v1/oauth/authorize": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1authorize" - "/v1/oauth/token": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1token" - "/v1/oauth/refresh": - "$ref": "OAuthAuthCode.yaml#/paths/~1v1~1oauth~1refresh" - "/security/v1/oauth/token": - "$ref": "OAuthClientCredentials.yaml#/paths/~1security~1v1~1oauth~1token" - "/paperlessdocuments/{version}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1upload" - "/paperlessdocuments/{version}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1image" - "/paperlessdocuments/{version}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{version}~1DocumentId~1ShipperNumber" - "/paperlessdocuments/{deprecatedVersion}/upload": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1upload" - "/paperlessdocuments/{deprecatedVersion}/image": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1image" - "/paperlessdocuments/{deprecatedVersion}/DocumentId/ShipperNumber": - "$ref": "Paperless.yaml#/paths/~1paperlessdocuments~1{deprecatedVersion}~1DocumentId~1ShipperNumber" - "/shipments/{version}/pickup/{pickuptype}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{pickuptype}" - "/shipments/{version}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{version}~1pickup~1{CancelBy}" - "/pickupcreation/{version}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{version}~1pickup" - "/pickup/{version}/countries/{countrycode}": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1countries~1{countrycode}" - "/pickup/{version}/servicecenterlocations": - "$ref": "Pickup.yaml#/paths/~1pickup~1{version}~1servicecenterlocations" - "/shipments/{deprecatedVersion}/pickup/{CancelBy}": - "$ref": "Pickup.yaml#/paths/~1shipments~1{deprecatedVersion}~1pickup~1{CancelBy}" - "/pickupcreation/{deprecatedVersion}/pickup": - "$ref": "Pickup.yaml#/paths/~1pickupcreation~1{deprecatedVersion}~1pickup" - "/dangerousgoods/{version}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{version}~1prenotification" - "/dangerousgoods/{deprecatedVersion}/prenotification": - "$ref": "PreNotification.yaml#/paths/~1dangerousgoods~1{deprecatedVersion}~1prenotification" - "/quantumview/{version}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{version}~1events" - "/quantumview/{deprecatedVersion}/events": - "$ref": "QuantumView.yaml#/paths/~1quantumview~1{deprecatedVersion}~1events" - "/rating/{version}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{version}~1{requestoption}" - "/rating/{deprecatedVersion}/{requestoption}": - "$ref": "Rating.yaml#/paths/~1rating~1{deprecatedVersion}~1{requestoption}" - "/shipments/{version}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1ship" - "/shipments/{version}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{version}~1void~1cancel~1{shipmentidentificationnumber}" - "/labels/{version}/recovery": - "$ref": "Shipping.yaml#/paths/~1labels~1{version}~1recovery" - "/shipments/{deprecatedVersion}/ship": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1ship" - "/shipments/{deprecatedVersion}/void/cancel/{shipmentidentificationnumber}": - "$ref": "Shipping.yaml#/paths/~1shipments~1{deprecatedVersion}~1void~1cancel~1{shipmentidentificationnumber}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/child-shipments/{tracking-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1child-shipments~1{tracking-number}" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/closeout": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1closeout" - "/ship/tradedirect/{version}/master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1{usi-number}~1ltl-child-shipments~1{sub-pro-number}" - "/ship/tradedirect/{version}/master-shipments/documents": - "$ref": "TradeDirect.yaml#/paths/~1master-shipments~1documents" - "/shipments/{version}/transittimes": - "$ref": "TimeInTransit.yaml#/paths/~1shipments~1{version}~1transittimes" - "/track/v1/details/{inquiryNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1details~1{inquiryNumber}" - "/track/v1/reference/details/{referenceNumber}": - "$ref": "Tracking.yaml#/paths/~1track~1v1~1reference~1details~1{referenceNumber}" - "/track/{version}/subscription/enhanced/package": - "$ref": "UPSTrackAlertEnhanced.yaml#/paths/~1subscription~1enhanced~1package" - "/deliveryintercept/{version}/charges/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1charges~1{tracking_number}" - "/deliveryintercept/{version}/eligibility/intercept/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1eligibility~1intercept~1{tracking_number}" - "/deliveryintercept/{version}/redirect/address/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1redirect~1address~1{tracking_number}" - "/deliveryintercept/{version}/willcall/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1willcall~1{tracking_number}" - "/deliveryintercept/{version}/return/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1return~1{tracking_number}" - "/deliveryintercept/{version}/reschedule/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1reschedule~1{tracking_number}" - "/deliveryintercept/{version}/cancel/{tracking_number}": - "$ref": "DeliveryIntercept.yaml#/paths/~1cancel~1{tracking_number}" - "/deliverydefense/external/v1.0/address/score": - "$ref": "DeliveryDefense.yaml#/paths/~1address~1score" - "/brokerage/{version}/importexport/exportassure": - "$ref": "UPSExportAssure.yaml#/paths/~1importexport~1exportassure" - "/export-assure/{version}/interactive": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive" - "/export-assure/{version}/interactive/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1{sessionId}" - "/export-assure/{version}/interactive/feedback/{sessionId}": - "$ref": "InteractiveDescriptionGuidance.yaml#/paths/~1interactive~1feedback~1{sessionId}" - "/ship/{version}/master-shipment/closeout/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1closeout~1{shipment-gccn}" - "/ship/{version}/master-shipment/{shipment-gccn}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1master-shipment~1{shipment-gccn}" - "/ship/{version}/child-shipment/{shipment-gccn}/{tracking-number}": - "$ref": "WorldEaseShipmentManagement.yaml#/paths/~1child-shipment~1{shipment-gccn}~1{tracking-number}" - "/track/{version}/subscription/standard/package": - "$ref": "UPSTrackAlert.yaml#/paths/~1subscription~1standard~1package" -webhooks: - TrackingEvent: - "$ref": "UPSTrackAlert.yaml#/webhooks/TrackingEvent" - TrackingEventEnhanced: - "$ref": "UPSTrackAlertEnhanced.yaml#/webhooks/TrackingEventEnhanced" -components: - securitySchemes: - OAuth2: - $ref: 'AddressValidation.yaml#/components/securitySchemes/OAuth2' - BasicAuth: - $ref: 'OAuthClientCredentials.yaml#/components/securitySchemes/BasicAuth' - BasicAuthGenerate: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthGenerate' - BasicAuthRefresh: - $ref: 'OAuthAuthCode.yaml#/components/securitySchemes/BasicAuthRefresh' From 41bd5057009ccab4e4a0e194efdb1063140cc0a7 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 7 Nov 2025 17:11:24 -0500 Subject: [PATCH 20/89] Update --- Forwarding.yaml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index 598b213..ef8881a 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -3,7 +3,7 @@ info: title: Forwarding API v1 version: "1.0" description: | - Links the UPS Forarding Hub to backend applications for the management of ocean and air freight shipments. + Links the UPS Forwarding Hub to backend applications for the management of ocean and air freight shipments. # Key Business Values - UPS Forwarding Hub APIs unify ocean and air freight through a single, modern RESTful interface. @@ -300,7 +300,7 @@ paths: message: Internal Server Error /orders: post: - summary: Create a order + summary: Create a Order operationId: orderCreate description: Create a pending order which becomes a shipment when processed at end-of-day parameters: @@ -657,7 +657,7 @@ paths: - code: "1003" message: Internal Server Error delete: - summary: Cancel an order + summary: Cancel an Order operationId: orderCancel tags: - Orders @@ -816,7 +816,7 @@ paths: - code: "1003" message: Internal Server Error patch: - summary: Set Date for orders + summary: Set Date for Orders operationId: orderSetDate tags: - Orders @@ -1474,7 +1474,7 @@ paths: /shipments: patch: - summary: Processes all shipments + summary: Processes All Shipments operationId: submitAirShipment tags: - Forwarding @@ -1706,7 +1706,7 @@ paths: - code: "1003" message: Internal Server Error delete: - summary: Cancels a shipment + summary: Cancels a Shipment operationId: cancelAirShipment tags: - Shipments @@ -2396,7 +2396,7 @@ paths: operationId: getCity tags: - Forwarding - summary: City Data. + summary: City Data description: Retrieves city details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -2582,7 +2582,7 @@ paths: operationId: getCurrencies tags: - Forwarding - summary: Retrieves Currencies. + summary: Retrieves Currencies description: Retrieves the currency details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -2741,7 +2741,7 @@ paths: operationId: getAirPaymentTypes tags: - Forwarding - summary: get payment types. + summary: Get Payment Types description: Retrieves payment types matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -2943,7 +2943,7 @@ paths: operationId: getCountries tags: - Forwarding - summary: Country Data. + summary: Get Country Data description: Retrieves country details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" From 61b70a5152caababa726e83a181aff0ec7ffcee4 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 7 Nov 2025 17:44:36 -0500 Subject: [PATCH 21/89] Update --- Forwarding.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index ef8881a..f2feb1b 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -660,7 +660,7 @@ paths: summary: Cancel an Order operationId: orderCancel tags: - - Orders + - Forwarding description: Cancel an pending order parameters: - $ref: "#/components/parameters/transId" @@ -819,7 +819,7 @@ paths: summary: Set Date for Orders operationId: orderSetDate tags: - - Orders + - Forwarding description: Set Date for one or all active orders from a shipper to a future date. Past dates are not allowed except for yesterday parameters: - $ref: "#/components/parameters/transId" @@ -1008,7 +1008,7 @@ paths: summary: Order Search operationId: orderSearch tags: - - Orders + - Forwarding description: Search for orders based on criteria parameters: - $ref: "#/components/parameters/transId" From bfb98ce8938c7cc9aa33d0798437b0ad6a2cf7b8 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 7 Nov 2025 17:48:07 -0500 Subject: [PATCH 22/89] Update --- Forwarding.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index f2feb1b..d969784 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -1709,7 +1709,7 @@ paths: summary: Cancels a Shipment operationId: cancelAirShipment tags: - - Shipments + - Forwarding description: Cancels a shipment using the provided shipment number and shipper's UPS Freight Account Number. parameters: - $ref: "#/components/parameters/transId" @@ -1868,7 +1868,7 @@ paths: description: Generate estimated freight rates based on the provided shipment and party details, and create the shipment. operationId: freightShip tags: - - Shipments + - Forwarding parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" From 9aba3f864a2e1fa7c89b94ddbd92e43ea03f6972 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 7 Nov 2025 17:50:14 -0500 Subject: [PATCH 23/89] Update --- Forwarding.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index d969784..6116017 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -1209,7 +1209,7 @@ paths: message: Internal Server Error /documents/labels: post: - summary: Re-Print label + summary: Re-Print Label operationId: printLabel tags: - Forwarding From 063c3835bb5f768c448c43bba19a77d0baa3ffdf Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 10 Nov 2025 12:09:29 -0500 Subject: [PATCH 24/89] Update --- Shipping.yaml | 132 +++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 124 insertions(+), 8 deletions(-) diff --git a/Shipping.yaml b/Shipping.yaml index b0d24d9..4dba814 100644 --- a/Shipping.yaml +++ b/Shipping.yaml @@ -5807,7 +5807,7 @@ components: minLength: 2 maxLength: 2 xml: - name: BillShipper + name: BillShipper description: Container for the BillShipper billing option. The three payment methods that are available for the Bill Shipper billing option are alternate payment method, account number or credit card. This element or its sibling @@ -6475,8 +6475,7 @@ components: - 83 = UPS Today Dedicated Courier - 84 = UPS Today Intercity - 85 = UPS Today Express - - 86 = UPS Today Express Saver - - 93 = Ground Saver + - 86 = UPS Today Express Saver - 96 = UPS Worldwide Express Freight. - C6 = Roadie XD AM (Morning delivery) - C7 = Roadie XD PM (Afternoon delivery) @@ -9439,10 +9438,11 @@ components: Valid values: - LTL - - SMALLPACKAGE + - SMALLPACKAGE + - MI type: string - enum: ["LTL", "SMALLPACKAGE"] + enum: ["LTL", "SMALLPACKAGE", "MI"] Product: $ref: '#/components/schemas/Child_Product' LtlPackage: @@ -9535,6 +9535,123 @@ components: type: string enum: [ "BA", "BE", "BG", "BH", "BOX", "BT", "LB", "LBS", "L", "M", "NMB", "PA", "BU", "CI", "CM", "CON", "CR", "CS", "CT", "CY", "DOZ", "EA", "EN", "FT", "KG", "KGS", "PAL", "PC", "PCS", "PF", "OTH", "PKG", "PR", "PRS", "RL", "SET", "SME", "SYD", "TU", "YD" ] + CommodityCode: + description: '6-to-15-alphanumeric commodity code. Customs uses this code + to determine what duties should be assessed on the commodity. Applies + to Invoice, Partial Invoice and USMCA. Required for USMCA and optional + for Partial Invoice. Should be at least 6 alphanumeric. For USMCA: + For each good described in Description of Goods field, identify the H.S. + tariff classification to six digits. If the good is subject to a specific + rule of origin in Annex 401 that requires eight digits, identify to eight + digits, using the H.S. tariff classification of the country or territory + into whose territory the good is imported.' + maximum: 1 + type: string + minLength: 6 + maxLength: 15 + JointProductionIndicator: + description: If present, JNT will be used as the origin of country or territory + code on the USMCA form and the Product/Origincountry or territoryCode + tag will be ignored. Applies to USMCA only. + maximum: 1 + type: string + NetCostCode: + description: | + For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values: + - NC + - ND + - NO + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + NetCostDateRange: + "$ref": "#/components/schemas/Product_NetCostDateRange" + PreferenceCriteria: + description: "Indicates the criterion (A through F) for each good described + in the Description of Goods field if applicable. \n\nThe rules of origin + are contained in Chapter Four and Annex 401. \n\nAdditional rules are + described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix + 6 (certain textile goods) and Annex 308.1 (certain automatic data processing + goods and their parts). Applies to USMCA only." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ProducerInfo: + description: "Indicate the following: Yes - If shipper is the producer + of the good. If not, state 02, 03, and 04 depending on whether this certificate + was based upon: \nNo [1] - Knowledge of whether the good qualifies as + an originating good. \nNo [2] - Reliance on the producers written representation + (other than a Certificate of Origin) that the good qualifies as an originating + good. \nNo [3] - A completed and signed Certificate for the good voluntarily + provided to the exporter by the producer. Applicable for USMCA and + is required. Valid values: Yes, No [1], No [2], and No [3]." + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + MarksAndNumbers: + description: Any special marks, codes, and numbers that may appear on package. Applies + to CO Only. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + NumberOfPackagesPerCommodity: + description: The total number of packages, cartons, or containers for the + commodity. Applicable for CO and is required. Should be numeric. Valid + characters are 0 -9. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + ProductWeight: + "$ref": "#/components/schemas/Product_ProductWeight" + VehicleID: + description: 'Includes the following information for used self-propelled + vehicles as defined in Customs regulations 19 CFR 192.1: The unique Vehicle + Identification Number (VIN) in the proper format. Or The Product Identification + Number (PIN) for those used self-propelled vehicles for which there are + no VINs. Or the Vehicle Title Number. Applies to EEI forms only.' + maximum: 1 + type: string + minLength: 1 + maxLength: 25 + ScheduleB: + "$ref": "#/components/schemas/Product_ScheduleB" + ExportType: + description: 'Code indicating Domestic: Exports that have been produced, + manufactured, or grown in the United States or Puerto Rico. This includes + imported merchandise which has been enhanced in value or changed from + the form in which imported by further manufacture or processing in the + United States or Puerto Rico. Foreign: Merchandise that has entered the + United States and is being exported again in the same condition as when + imported. Applies to EEI forms only. Required for EEI form. Valid values: D: + Domestic; F: Foreign.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + SEDTotalValue: + description: | + This amount will always be USD. Applies to EEI forms only. Required for EEI form. Valid characters are 0-9 and \'.\' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including \'.\' and can hold up to 2 decimal places. + + Note: This value is calculated based on the Product/Unit/Value and /Product/Unit/Number (Number of Units * Price per Unit). If the total value is incorrect it will be replaced by the actual calculated total value. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + TaxesPaid: + description: "Invoice Commodity Level Tax Collected Code for each shipment commodity line.Taxes paid Indicator is only applicable for shipments to Singapore. [TaxesPaid = 0 - No on Report], [TaxesPaid = 1 -Yes on Report], [TaxesPaid = empty - null on Report], [If TaxesPaid is not passed in input request = null on Report]" + type: string + ExcludeFromForm: + "$ref": "#/components/schemas/Product_ExcludeFromForm" + PackingListInfo: + "$ref": "#/components/schemas/Product_PackingListInfo" + EEIInformation: + "$ref": "#/components/schemas/Product_EEIInformation" + xml: name: Product description: This variable represents the product details. It is used to provide information about the product being shipped. @@ -10735,9 +10852,8 @@ components: RegulationSet: description: 'Regulation set for dryIce Shipment. Valid values: CFR = HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments - to Canada, IATA= Worldwide Air movement, ADR = Europe to - Europe Ground Movement. The following values are valid: - IATA, CFR, ADR.' + to Canada, IATA= Worldwide Air movement. The following values are valid: + IATA, CFR.' maximum: 1 type: string minLength: 3 From d706853090f4b11dc0da6d017eda0adf5838fcb1 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 5 Dec 2025 15:25:56 -0500 Subject: [PATCH 25/89] update Add OpenAPI specification for Direct-to-Mobile API, detailing endpoints, request/response schemas, and authentication methods. --- Direct-to-Mobile.yaml | 1001 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1001 insertions(+) create mode 100644 Direct-to-Mobile.yaml diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml new file mode 100644 index 0000000..769adfc --- /dev/null +++ b/Direct-to-Mobile.yaml @@ -0,0 +1,1001 @@ +openapi: 3.1.0 +info: + title: "Direct-to-Mobile API v1" + description: |- + The UPS Direct to Mobile program enables retailers, manufacturers, and other + UPS shippers to offer their customers a convenient “No printer? No problem.” package label option for + forward shipments and returns. + + **Key Business Values:** + - This API provides the capability to participate in the “No Box, No Label” return program. + - The Direct to Mobile API is a paid contract program that supports ALL of the different types of drop-offs (forward AND return shipments) within a single DTM API request. + + - **Label Only** + The drop-off item is required to arrive at the store packed and sealed. + - **No Box No Label** + Does not require the item be pre-packed. The unpacked/loose drop-off item is eligible for the “No + Box No Label / 360 Simple Returns” shipping pak program. + - **Label & Packaging** + Does not require the item be pre-packed. The drop-off item is eligible for a custom The UPS + Store® packaging program. + version: "1.0" + contact: + name: "Priyanka Manubarthi" + email: "pmanubarthi@ups.com" +tags: + - name: "Direct-to-Mobile" + description: Provides the capability to participate in the new “No Box, No Label” return program. + +servers: + - url: "https://onlinetools.ups.com/api/ups-store/iship/{version}" + description: URL for OAuth based authentication that can be used for any environment (production, staging, product test) via hosts file. + variables: + version: + default: v1 + enum: + - v1 +paths: + /direct-to-mobile: + post: + summary: Create a Direct to Mobile Dropoff + description: | + Creates a Direct to Mobile (DTM) drop-off entry. This endpoint is used after a shipment has been created in the retailer's manifesting system. + operationId: createDropoff + tags: + - Direct-to-Mobile + security: + - oauth2: [] + parameters: + - name: transId + in: header + style: simple + required: true + description: Unique ID used for dropoff requests. + schema: + type: string + example: dtm20241205111040 + - name: transactionSrc + in: header + style: simple + required: true + description: Identifies the client/source application that is calling. + schema: + type: string + - name: Content-Type + in: header + description: The Content Type header is used to indicate the acceptable body format of the response coming from the API. + required: true + schema: + type: string + example: application/json;type=vnd.iShip.Dropoff + - $ref: "#/components/parameters/x-iship-date" + - $ref: "#/components/parameters/x-iship-CorrelationID" + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DirectToMobileRequest' + example: + description: "Coffee maker" + fromAddress: + companyName: "Jane Doe" + contactName: "" + address1: "12020 101st Ave NE" + address2: "Apt F1" + address3: "" + city: "Kirkland" + stateProv: "WA" + postalCode: "98034" + country: "US" + phone: "4255554848" + toAddress: + companyName: "Central Perk" + address1: "1234 Returns Way" + address2: "#D4" + address3: null + city: "New York" + stateProv: "NY" + postalCode: "10101" + country: "US" + phone: "4255551234" + dimensions: + units: "inches" + height: 10 + length: 8 + width: 6 + weight: + actual: + units: "lbs" + value: 3.5 + billable: + units: "lbs" + value: 0 + dimensionalWeight: + units: "lbs" + value: "" + chargeMethod: 0 + referenceNumbers: + reference1: "customer reference 1" + reference2: "customer reference 2" + mobileInfo: + mobileId: "RMA0037488" + billMethod: 2 + movementType: 1 + programType: 2 + programRef1: "Central Perk" + programRef2: "" + carrierId: 1 + cod: + amount: null + currencyCode: null + codPayType: null + codType: null + demoFlag: 1 + expiresAtUTC: null + hazardousMaterial: + detail: null + type: null + identification: + type: null + number: null + stateProv: null + country: null + returnsType: 1 + routeCode: null + saturdayDelivery: null + serviceID: 1991 + signatureType: null + sortCode: null + trackingNo: "1ZXX74W59018531040" + voidFlag: 0 + responses: + '200': + description: Successful dropoff creation + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + x-iship-RequestID: + $ref: "#/components/headers/x-iship-RequestID" + x-iship-date: + $ref: "#/components/headers/x-iship-date" + content: + application/json: + schema: + $ref: '#/components/schemas/DirectToMobileResponse' + example: + dropoffOID: "70318a17e84e451ebb80ea97664b7403" + fromAddress: + companyName: "Jane Doe" + address1: "12020 101st Ave NE" + city: "Kirkland" + stateProv: "WA" + postalCode: "98034" + country: "US" + phone: "4255554848" + toAddress: + companyName: "Central Perk" + address1: "1234 Returns Way" + city: "New York" + stateProv: "NY" + postalCode: "10101" + country: "US" + phone: "4255551234" + dimensions: + height: 10 + length: 8 + width: 6 + weight: + actual: + units: "lbs" + value: 3.5 + billable: + units: "lbs" + value: 0 + dimensional: + units: "lbs" + value: 0 + chargeMethod: 0 + manualFlag: 1 + referenceNumbers: + reference1: "RMA0037488" + reference2: "" + reference3: null + reference4: null + mobileInfo: + mobileId: "RMA0037488" + billMethod: 2 + movementType: 1 + programType: 2 + programRef1: "Central Perk" + programRef2: "" + cod: + amount: null + currencyCode: null + payType: null + type: null + hazardousMaterial: + messages: null + type: null + dropOffDocument: + documentPath: "urn:universalapplication1/edop.positiondocuments:Root/Enterprises/Mobile Edop/Mobile Dropoff/Document?docname=mobilereturns&xposfloat=30.0&yposfloat=75.0&symbology=code93&heightfloat=100.0&narrow=15&output=png" + imageOutput: "iVBORw0KGgoAAAANSUhEUgAAAfQAAAIcAQMAAAA65867AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAGUExURQAAAP///6XZn90AAAAJcEhZcwAAPYQAAD2EAdWsr3QAAAQ5SURBVHja7du9biM3EAfwVQScSiIvIAbIC5yruBDEJwmQPoVh+BAFkCEqTdRZT5A0eQiniSVDgNXFZYoUsrxFmkC3i8vdbqA9ToZcfQe3G0oWAvj+05gW9kdryeGA1MoBHRQRPPxhfhjsH/IZ+NH+o2fg4eHh4eHh4eHh4eHh4eHh4eHh4eHhPwY/DARlQVDYgIeHhz+qt082q/krQd6wkdlnfgoeHh7+SJ4jv2hVrbL8ywaCdgMeHh7+Cf0qdndLW13Dw8PDP71fXGSjumwEXuc3eHh4+IO8Wp7f7EFuEcLr/AYPDw/v6XfLlo3sXw14eHj4p/cbRWpxdbTsaFHIFDw8PPxR/KJ+LS7aakTrB2nw8PDwR/OL2Lo62uoaHh4e/om9WHfkYrWR8vn8Gh4eHn4vv33R6vuLu1sreHh4+GP53d3SqiOCh4eHP4rfKFJZvoMSy0bgcf6Dh4eH9/Yb/6Sx+/yMPM5/8PDw8N6+PBQ8PDz8EbxnwMPDw8PDw8PDw8PDw8P/Dz7TWUcaFVSNyhSfhfUDpSqTNNSpGoWVOhv6lIky3zFqFSzlw/aeW6wtj42gR6KIi/YB0ZF7rPABx2xN4EYVtKgwX6aBbJbLfEy7agp0ZicT/tGitE0ulT0hm6zpuyNinyNfdZUI+t7uc9UrxfFRtIfdJtqIaZFnsdOmqbqWT9+VI8q6mV63E+nJOmevkupL+Mi/3nuxcrHY+dD9n2qlPoT55tyw6cUykyzl+bTUv/S+YZyPpR3KgxzbxQpc1J6/6fOn2o3fps+VZxV56Xj3+jw+HdeWm+E9aNp7oea+zg3gRrWCn3Tzv9n2uaPDPu/qnGc+y77KCZO6sL8azZt/n2irFdh/2rtVUpxXJp/zbrN/xfSerK+ny7GT/LPOO0IcVvkFfuaESKqjqcU3v+ousFi/kRMo7h0/tSVkvx6j31E4bi+9v2YenFMd3wfRf5769WYfaqtD4JvV74bnJT6O+dDnr9MhWOejWzpw3LPK/fR+WnuHzmTs0ae/+Wey45RD85HNn+k9co08vUn+D0V3z//ytL51NWPhXfrn6T1heNPYsrSeb5f66NOQ1Pd1Z9Mjq1XovbB9UOucuZeufWT+7z+KesL84+6NSut52pl12/U4ZUo8vqrrS9cP1zal54E+1GYmlOivqv/FbK+sP57Bzw8PDw8PPxz8stNwmBAdFknbap+45e8Xvv5jOj9e0+frH3yjvt44euvkp/Ok8HP010y/Retdra03+TXF/MEvXDRLdN++La18/mX59dT84GNxN92Zm3fqv5+ai+9DPSV+zPPP++mX/51RfD3L9j3/L3Z8nk9eDmT2pZ397Du/f/1vnfDfl5at0kLTv+b6k9m1/84ps/1L9Jk5jnf875O3/V8czfdczz7mhfnxzo7w/0ReH8f/nOxIfiOfiDAv6j9hT9A/qf1YLYhevGAAAAAElFTkSuQmCC" + text: "UNPK-RMA0037488" + identification: + country: null + number: null + stateProv: null + type: null + accountNo: null + billingOptionId: 1 + carrierAccountId: null + carrierId: 1 + createdByAccountNO: "AXFDTR" + createDate: "2021-11-16T01:02:23.387" + demoFlag: 1 + description: null + dropoffGroupOID: null + dropoffStateId: 4 + dropoffTime: null + dropoffTimeUTC: null + dropoffType: null + dropoffTypeAbbr: null + expiresAtUTC: "2022-01-17T08:02:23.387" + notifyFlag: null + numberOfPackages: null + packageNumber: null + pickupDate: "2999-12-31T23:24:00" + pickupOID: "" + receiptPrintFlag: null + returnsType: 1 + routeCode: null + saturdayDelivery: false + serviceID: 1991 + shipDate: null + signatureType: null + sortCode: null + trackingNo: "1ZXX74W59018531040" + transactionTypeId: null + voidFlag: 0 + workstationOID: null + descriptionOfGoods: "Coffee maker" + '400': + $ref: "#/components/responses/BadRequest" + '401': + $ref: "#/components/responses/Unauthorized" + '403': + $ref: "#/components/responses/Forbidden" + '404': + $ref: "#/components/responses/NotFound" + '500': + $ref: "#/components/responses/InternalError" + '503': + $ref: "#/components/responses/ServiceMaintenance" + +components: + securitySchemes: + oauth2: + type: "oauth2" + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token + scopes: {} + headers: + BkndTransId: + description: The backend transaction id. This will be the same as the transId received from client or otherwise a random ID. + schema: + type: string + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + schema: + type: string + minLength: 3 + maxLength: 36 + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + schema: + type: string + minLength: 1 + maxLength: 36 + example: Burberry + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + schema: + type: number + example: 400 + APIErrorMsg: + description: The API error message. + schema: + type: string + example: Invalid token or token is not present. + x-iship-RequestID: + description: All responses returned from the Direct to Mobile API will include a x-iship-RequestID header that contains a unique 32-digit alphanumeric GUID (Globally Unique Identifier) that is assigned by the iShip server. + schema: + type: string + x-iship-date: + description: "Send a standard HTTP Date: header in every request. The Date: header may be blocked on some implementations of HTTP client APIs. If this occurs, use x-iship-date instead" + schema: + type: string + example: "Wed, 10 Nov 2021 21:42:37 GMT" + parameters: + x-iship-date: + name: x-iship-date + in: header + description: "Send a standard HTTP Date: header in every request. The Date: header may be blocked on some implementations of HTTP client APIs. If this occurs, use x-iship-date instead" + required: true + schema: + type: string + example: "Wed, 10 Nov 2021 21:42:37 GMT" + x-iship-CorrelationID: + name: x-iship-CorrelationID + in: header + description: Identifies the client/source application that is calling. + required: false + schema: + type: string + description: Optional GUID for correlating requests + example: "90aac7c1081c4720a8c48a632b144de8" + schemas: + DirectToMobileRequest: + type: object + required: + - description + - fromAddress + - toAddress + - dimensions + - weight + - mobileInfo + - trackingNo + - carrierId + - serviceID + properties: + description: + type: string + maxLength: 35 + description: Merchandise description / package contents. + fromAddress: + $ref: '#/components/schemas/Address' + toAddress: + $ref: '#/components/schemas/Address' + dimensions: + $ref: '#/components/schemas/Dimensions' + weight: + $ref: '#/components/schemas/Weight' + referenceNumbers: + description: Barcode & Text on Label + $ref: '#/components/schemas/ReferenceNumbers' + mobileInfo: + $ref: '#/components/schemas/MobileInfo' + carrierId: + type: integer + description: The value indicates the carrier type. + cod: + $ref: '#/components/schemas/COD' + demoFlag: + type: integer + enum: [0,1] + default: 0 + description: | + 0 : Live Drop Off Package (Default) + 1 : Demo Drop Off Package + expiresAtUTC: + type: string + format: date-time + nullable: true + description: UTC time that Dropoff package will expire. + hazardousMaterial: + $ref: '#/components/schemas/HazardousMaterial' + identification: + $ref: '#/components/schemas/Identification' + returnsType: + type: integer + description: | + 0 : No Return Service (Default) + 13 : Return Service - Print Label + routeCode: + type: string + maxLength: 40 + nullable: true + description: Destination routing code associated with UPS transaction. + saturdayDelivery: + type: integer + nullable: true + description: | + 0 : Not Selected (Default) + 1 : Saturday Delivery Requested + serviceID: + type: integer + description: Direct-to-Mobile service ID. + signatureType: + type: integer + nullable: true + description: | + 0 : No Selection / Preference (Default) + 1 : Signature Release + 2 : Signature Required + 3 : Adult Signature Required + sortCode: + type: string + maxLength: 2 + nullable: true + description: Custom Sort Code (Requires UPS Approval) + trackingNo: + type: string + description: Carrier tracking number of dropoff package. + voidFlag: + type: integer + description: | + 0 : Live Package + 1 : Voided Package + + # ADDRESS + Address: + type: object + required: + - companyName + - address1 + - city + - postalCode + - country + properties: + companyName: + type: string + maxLength: 35 + description: The sender's/receiver's personal name or a company name. + contactName: + type: string + maxLength: 35 + description: The sender's/receiver's contact name or attention. + address1: + type: string + maxLength: 35 + description: The sender's/receiver's street address. + address2: + type: string + maxLength: 35 + description: The sender's/receiver's Suite, Apt, Building, etc. + address3: + type: string + maxLength: 35 + nullable: true + description: Additional address information. + city: + type: string + maxLength: 40 + description: The sender's/receiver's city name. + stateProv: + type: string + maxLength: 15 + description: The sender's/receiver's State or Province. + postalCode: + type: string + maxLength: 10 + description: The sender's/receiver's Zip or postal code. + country: + type: string + maxLength: 2 + description: The sender's/receiver's Country or Territory Abbreviation e.g. “CA”, “MX” or “US” + phone: + type: string + maxLength: 25 + description: The sender's/receiver's Telephone number. + + # DIMENSIONS + Dimensions: + type: object + required: + - height + - length + - width + properties: + units: + type: string + enum: [inches, centimeters] + default: inches + height: + type: number + description: The height of the package + length: + type: number + description: The length of the package + width: + type: number + description: The width of the package + + # WEIGHT + Weight: + type: object + properties: + actual: + description: The actual weight of the package. + $ref: '#/components/schemas/WeightClass' + billable: + description: The billable weight of the package. + $ref: '#/components/schemas/WeightClass' + dimensional: + description: The dimensional weight of the package. + $ref: '#/components/schemas/WeightClass' + chargeMethod: + type: integer + description: | + The “chargeMethod” is a required Direct to Mobile API request element. + Actual Weight : 0 + Dimensional Weight : 1 + Oversize Weight : 2 + Letter Weight : 3 + Carrier Pack Billable Weight : 4 + Minimum Billable Weight for Large Package : 5 + Box Weight : 6 + manualFlag: + type: integer + WeightClass: + type: object + required: + - value + properties: + units: + type: string + enum: [lbs, kgs] + default: lbs + value: + type: number + description: Weight value. + default: 0 + + # REFERENCE NUMBERS + ReferenceNumbers: + type: object + properties: + reference1: + type: string + maxLength: 100 + nullable: true + reference2: + type: string + maxLength: 100 + nullable: true + reference3: + type: string + maxLength: 100 + nullable: true + reference4: + type: string + maxLength: 100 + nullable: true + # MOBILE INFO + MobileInfo: + type: object + required: + - mobileId + - programRef1 + properties: + mobileId: + type: string + maxLength: 35 + pattern: ^[a-zA-Z0-9]+$ + description: A unique identifier for the dropoff package. Value must be comprised of unaccented letters (a-z, A-Z) or numbers (0-9). + billMethod: + type: integer + enum: [1,2,3] + description: | + For accounting purposes; the value that identifies how the transactions will be billed and/or the entity responsible for billing. Inquire with iShip as to which value to use. + 1 : The UPS Store Corporate Retail Solutions (CRS) + 2 : value is reserved exclusively for the “No Box No Label” offering + 3 : UPS Solutions + movementType: + type: integer + enum: [1,2] + description: | + The value that identifies the movement of the item/shipment + 1 = Return + 2 = Forward + programType: + type: integer + enum: [1,2] + description: | + The value that identifies either how the item should arrive or how it should be processed when it reaches the drop-off location. + 1 = Label Only + 2 = Label & Packaging + programRef1: + type: string + maxLength: 100 + description: Human-readable retailer or shipper name. + programRef2: + type: string + maxLength: 100 + description: A reference value which is not visible to clerk or customer but can be reflected back in data feed or export. + # COD + COD: + type: object + properties: + amount: + type: number + description: Required when codType is greater than 0. + nullable: true + currencyCode: + type: string + maxLength: 3 + description: ISO 3-character abbreviation “USD” (US Dollar), “MXN” (Mexican Peso), etc. + nullable: true + payType: + type: integer + nullable: true + description: | + Required when codType is greater than 0 + 1 : Guaranteed + 2 : Cash Only + 3 : Any Funds + type: + type: integer + nullable: true + description: | + 0 : Not Selected (Default) + 11 : Regular COD + + # RESPONSE SCHEMA + DirectToMobileResponse: + type: object + properties: + dropoffOID: + type: string + fromAddress: + $ref: '#/components/schemas/Address' + toAddress: + $ref: '#/components/schemas/Address' + dimensions: + $ref: '#/components/schemas/Dimensions' + weight: + $ref: '#/components/schemas/Weight' + referenceNumbers: + $ref: '#/components/schemas/ReferenceNumbers' + mobileInfo: + $ref: '#/components/schemas/MobileInfo' + cod: + $ref: '#/components/schemas/COD' + hazardousMaterial: + $ref: '#/components/schemas/HazardousMaterial' + dropOffDocument: + $ref: '#/components/schemas/DropOffDocument' + identification: + $ref: '#/components/schemas/Identification' + accountNo: + type: string + nullable: true + billingOptionID: + type: integer + enum: [1,2,3,9] + carrierAccountId: + type: string + nullable: true + carrierID: + type: integer + createdByAccountNO: + type: string + nullable: true + createDate: + type: string + nullable: true + demoFlag: + type: integer + description: + type: string + nullable: true + dropoffGroupOID: + type: string + nullable: true + dropoffStateId: + type: integer + nullable: true + dropoffTime: + type: string + nullable: true + dropoffTimeUTC: + type: string + nullable: true + dropoffType: + type: string + nullable: true + dropoffTypeAbbr: + type: string + nullable: true + expiresAtUTC: + type: string + nullable: true + notifyFlag: + type: string + nullable: true + numberOfPackages: + type: string + nullable: true + packageNumber: + type: string + nullable: true + pickupDate: + type: string + nullable: true + pickupOID: + type: string + nullable: true + receiptPrintFlag: + type: string + nullable: true + returnsType: + type: integer + nullable: true + routeCode: + type: string + nullable: true + saturdayDelivery: + type: boolean + nullable: true + serviceID: + type: integer + shipDate: + type: string + nullable: true + signatureType: + type: integer + nullable: true + sortCode: + type: string + nullable: true + trackingNo: + type: string + nullable: true + transactionTypeId: + type: string + nullable: true + voidFlag: + type: integer + nullable: true + workstationOID: + type: string + nullable: true + descriptionOfGoods: + type: string + nullable: true + # DROP OFF DOCUMENT (IMAGE + TEXT) + DropOffDocument: + type: object + properties: + documentPath: + type: string + imageOutput: + type: string + description: Base64 encoded barcode image. + text: + type: string + description: Human-readable barcode text. + # identification + Identification: + type: object + properties: + country: + type: string + nullable: true + number: + type: string + nullable: true + description: Internal Use. + stateProv: + type: string + nullable: true + description: Internal Use. + type: + type: string + nullable: true + description: Internal Use. + # hazardousMaterial + HazardousMaterial: + type: object + properties: + messages: + type: string + nullable: true + type: + type: string + description: Internal Use. + nullable: true + + ErrorResponse: + type: object + description: Response object for errors + properties: + response: + description: Response container to store errors + type: object + properties: + errors: + type: array + description: Unbounded array containing one or more errors + items: + type: object + description: Error entity + properties: + code: + type: integer + description: error code + message: + type: string + description: error message + minLength: 1 + required: + - code + - message + additionalProperties: false + required: + - errors + additionalProperties: false + required: + - response + additionalProperties: false + + responses: + BadRequest: + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + example: + response: + errors: + - code: 400 + message: The URI could not be parsed + + Unauthorized: + description: Authentication failed + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + example: + response: + errors: + - code: 401 + message: Authentication failed + + Forbidden: + description: Authorization Failed + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + example: + response: + errors: + - code: 403 + message: Authorization Failed + + NotFound: + description: Unknown URI + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + example: + response: + errors: + - code: 404 + message: The service could not find the resource requested. + InternalError: + description: This is a server-side issue. + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + example: + response: + errors: + - code: 500 + message: The service encountered an error and couldn't continue. + ServiceMaintenance: + description: This error may appear during regular scheduled data center maintenance. + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + example: + response: + errors: + - code: 503 + message: Sorry for the inconvenience. The service is down for maintenance. From 174eaaa50317450360cebb35e7f73baf527ec5d3 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 5 Dec 2025 15:27:01 -0500 Subject: [PATCH 26/89] update Removed contact information for Priyanka Manubarthi from the YAML file. --- Direct-to-Mobile.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml index 769adfc..afe43a4 100644 --- a/Direct-to-Mobile.yaml +++ b/Direct-to-Mobile.yaml @@ -19,9 +19,6 @@ info: Does not require the item be pre-packed. The drop-off item is eligible for a custom The UPS Store® packaging program. version: "1.0" - contact: - name: "Priyanka Manubarthi" - email: "pmanubarthi@ups.com" tags: - name: "Direct-to-Mobile" description: Provides the capability to participate in the new “No Box, No Label” return program. From 9963ceb9f1a52d2251c774f4316ea1d14afbb54d Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 5 Dec 2025 15:41:44 -0500 Subject: [PATCH 27/89] update --- Direct-to-Mobile.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml index afe43a4..815e97a 100644 --- a/Direct-to-Mobile.yaml +++ b/Direct-to-Mobile.yaml @@ -20,7 +20,7 @@ info: Store® packaging program. version: "1.0" tags: - - name: "Direct-to-Mobile" + - name: "Direct-To-Mobile" description: Provides the capability to participate in the new “No Box, No Label” return program. servers: @@ -39,7 +39,7 @@ paths: Creates a Direct to Mobile (DTM) drop-off entry. This endpoint is used after a shipment has been created in the retailer's manifesting system. operationId: createDropoff tags: - - Direct-to-Mobile + - Direct-To-Mobile security: - oauth2: [] parameters: @@ -423,7 +423,7 @@ components: 1 : Saturday Delivery Requested serviceID: type: integer - description: Direct-to-Mobile service ID. + description: service ID. signatureType: type: integer nullable: true From aa7921134c8184c34f1e12d038cb586741263c21 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 5 Dec 2025 15:47:07 -0500 Subject: [PATCH 28/89] Update --- Direct-to-Mobile.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml index 815e97a..3b485f2 100644 --- a/Direct-to-Mobile.yaml +++ b/Direct-to-Mobile.yaml @@ -6,7 +6,7 @@ info: UPS shippers to offer their customers a convenient “No printer? No problem.” package label option for forward shipments and returns. - **Key Business Values:** + ## Key Business Values - This API provides the capability to participate in the “No Box, No Label” return program. - The Direct to Mobile API is a paid contract program that supports ALL of the different types of drop-offs (forward AND return shipments) within a single DTM API request. @@ -18,7 +18,7 @@ info: - **Label & Packaging** Does not require the item be pre-packed. The drop-off item is eligible for a custom The UPS Store® packaging program. - version: "1.0" + version: "1.0" tags: - name: "Direct-To-Mobile" description: Provides the capability to participate in the new “No Box, No Label” return program. From 2ee68faf1ef884d3b66e0c611d084951d212750e Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 5 Dec 2025 15:51:38 -0500 Subject: [PATCH 29/89] update Updated the description section to improve formatting and clarity. --- Direct-to-Mobile.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml index 3b485f2..089a5d8 100644 --- a/Direct-to-Mobile.yaml +++ b/Direct-to-Mobile.yaml @@ -1,12 +1,12 @@ openapi: 3.1.0 info: title: "Direct-to-Mobile API v1" - description: |- + description: | The UPS Direct to Mobile program enables retailers, manufacturers, and other UPS shippers to offer their customers a convenient “No printer? No problem.” package label option for forward shipments and returns. - ## Key Business Values + ## Key Business Values - This API provides the capability to participate in the “No Box, No Label” return program. - The Direct to Mobile API is a paid contract program that supports ALL of the different types of drop-offs (forward AND return shipments) within a single DTM API request. From d4814b8259bd15b425ac3c6a2fecbb118392d2f9 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 5 Dec 2025 16:08:56 -0500 Subject: [PATCH 30/89] Update Removed extra whitespace and adjusted formatting in the Direct-to-Mobile.yaml file. --- Direct-to-Mobile.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml index 089a5d8..3df857e 100644 --- a/Direct-to-Mobile.yaml +++ b/Direct-to-Mobile.yaml @@ -5,10 +5,10 @@ info: The UPS Direct to Mobile program enables retailers, manufacturers, and other UPS shippers to offer their customers a convenient “No printer? No problem.” package label option for forward shipments and returns. - + ## Key Business Values - - This API provides the capability to participate in the “No Box, No Label” return program. - - The Direct to Mobile API is a paid contract program that supports ALL of the different types of drop-offs (forward AND return shipments) within a single DTM API request. + - This API provides the capability to participate in the “No Box, No Label” return program. + - The Direct to Mobile API is a paid contract program that supports ALL of the different types of drop-offs (forward AND return shipments) within a single DTM API request. - **Label Only** The drop-off item is required to arrive at the store packed and sealed. From 7320898db4521676a8ccf45a06785901fdb406d4 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 8 Dec 2025 15:19:29 -0500 Subject: [PATCH 31/89] Update --- Direct-to-Mobile.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml index 3df857e..f3eb196 100644 --- a/Direct-to-Mobile.yaml +++ b/Direct-to-Mobile.yaml @@ -18,6 +18,10 @@ info: - **Label & Packaging** Does not require the item be pre-packed. The drop-off item is eligible for a custom The UPS Store® packaging program. + + # Reference + - Errors + version: "1.0" tags: - name: "Direct-To-Mobile" From 93297990cf33e2ad3e2402b9d8bead899a780092 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 8 Dec 2025 15:23:24 -0500 Subject: [PATCH 32/89] update --- Direct-to-Mobile.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml index f3eb196..288f83c 100644 --- a/Direct-to-Mobile.yaml +++ b/Direct-to-Mobile.yaml @@ -6,7 +6,7 @@ info: UPS shippers to offer their customers a convenient “No printer? No problem.” package label option for forward shipments and returns. - ## Key Business Values + # Key Business Values - This API provides the capability to participate in the “No Box, No Label” return program. - The Direct to Mobile API is a paid contract program that supports ALL of the different types of drop-offs (forward AND return shipments) within a single DTM API request. From edae1bea0ab21e310af3ee8806902cd930e9bed6 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 12 Jan 2026 11:10:53 -0500 Subject: [PATCH 33/89] Update Update --- OAuthAuthCode-Ready.yaml | 5 +++-- OAuthAuthCode.yaml | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/OAuthAuthCode-Ready.yaml b/OAuthAuthCode-Ready.yaml index 5ef0bbf..ff2c9c6 100644 --- a/OAuthAuthCode-Ready.yaml +++ b/OAuthAuthCode-Ready.yaml @@ -110,7 +110,7 @@ paths: headers: location: description: |- - The UPS login redirection URI in the following format: https://www.ups.com/lasso/signin?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api + The UPS login redirection URI in the following format: https://{UPS_domain_URL}?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api The value of 'state' will be the same value that the application initially set in the request. The 'code' is the authorization code generated by the authorization server. @@ -419,4 +419,5 @@ components: type: string message: description: Error message - type: string \ No newline at end of file + + type: string diff --git a/OAuthAuthCode.yaml b/OAuthAuthCode.yaml index f1f8f12..51bb775 100644 --- a/OAuthAuthCode.yaml +++ b/OAuthAuthCode.yaml @@ -103,7 +103,7 @@ paths: headers: location: description: |- - The UPS login redirection URI in the following format: https://www.ups.com/lasso/signin?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api + The UPS login redirection URI in the following format: https://{UPS_domain_URL}?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}&type=ups_com_api The value of 'state' will be the same value that the application initially set in the request. The 'code' is the authorization code generated by the authorization server. @@ -412,4 +412,5 @@ components: type: string message: description: Error message - type: string \ No newline at end of file + + type: string From 243389a65cb7bea28397ffb44e016826b00ff056 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 13 Jan 2026 09:22:28 -0500 Subject: [PATCH 34/89] Update --- Tracking.yaml | 89 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 87 insertions(+), 2 deletions(-) diff --git a/Tracking.yaml b/Tracking.yaml index 1b3b35f..61ed0c6 100644 --- a/Tracking.yaml +++ b/Tracking.yaml @@ -240,6 +240,93 @@ paths: schema: "$ref": "#/components/schemas/Response" deprecated: false + "/track/v1/shipment/details/{inquiryNumber}": + get: + summary: Track each pacakge in shipment + tags: + - Tracking + security: + - OAuth2: [] + description: '' + operationId: Shipment Tracking API + parameters: + - name: inquiryNumber + in: path + description: The tracking number for which tracking information is requested. + Each inquiry number must be between 7 and 34 characters in length. + required: true + schema: + type: string + - name: locale + in: query + description: Language and country code of the user, separated by an underscore. + Default value is 'en_US' + schema: + type: string + default: en_US + - name: offset + in: query + description: This is used to support pagination of package results. The offset is a 0-based index which defines the starting record to be returned. + schema: + type: string + default: 0 + - name: count + in: query + description: This is used to support pagination of package results. The count is the maximum number of packages to return starting with the offset. + schema: + type: string + default: 50 + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling + required: true + schema: + type: string + default: testing + responses: + '200': + description: Tracking Information found + content: + "application/json": + schema: + "$ref": "#/components/schemas/TrackApiResponse" + '400': + description: Invalid request + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/Response" + '404': + description: Tracking number information not found + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '500': + description: Internal server error + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '503': + description: Resource is not available + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + deprecated: false components: securitySchemes: OAuth2: @@ -827,5 +914,3 @@ components: type: string description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. ''KGS'' - kilograms.' - - From 5bc16c0ed92aca5a8e9d1ccab2ec4403d80cb957 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 13 Jan 2026 09:22:58 -0500 Subject: [PATCH 35/89] Update --- Tracking-Ready.yaml | 92 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 89 insertions(+), 3 deletions(-) diff --git a/Tracking-Ready.yaml b/Tracking-Ready.yaml index 747c97c..9aca9a7 100644 --- a/Tracking-Ready.yaml +++ b/Tracking-Ready.yaml @@ -18,6 +18,7 @@ info: - Business Rules - Appendix - Errors + - Tracking Best Practices - Accelerate API Integration with UPS MCP Server Simplify your workflow with the API Request Generator and create your custom request body in just seconds. @@ -26,8 +27,7 @@ info: API Request Generator -
-

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

@@ -246,6 +246,93 @@ paths: schema: "$ref": "#/components/schemas/Response" deprecated: false + "/track/v1/shipment/details/{inquiryNumber}": + get: + summary: Track each pacakge in shipment + tags: + - Tracking + security: + - OAuth2: [] + description: '' + operationId: Shipment Tracking API + parameters: + - name: inquiryNumber + in: path + description: The tracking number for which tracking information is requested. + Each inquiry number must be between 7 and 34 characters in length. + required: true + schema: + type: string + - name: locale + in: query + description: Language and country code of the user, separated by an underscore. + Default value is 'en_US' + schema: + type: string + default: en_US + - name: offset + in: query + description: This is used to support pagination of package results. The offset is a 0-based index which defines the starting record to be returned. + schema: + type: string + default: 0 + - name: count + in: query + description: This is used to support pagination of package results. The count is the maximum number of packages to return starting with the offset. + schema: + type: string + default: 50 + - name: transId + in: header + description: An identifier unique to the request. + required: true + schema: + type: string + - name: transactionSrc + in: header + description: Identifies the client/source application that is calling + required: true + schema: + type: string + default: testing + responses: + '200': + description: Tracking Information found + content: + "application/json": + schema: + "$ref": "#/components/schemas/TrackApiResponse" + '400': + description: Invalid request + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '403': + description: Blocked Merchant + content: + application/json: + schema: + "$ref": "#/components/schemas/Response" + '404': + description: Tracking number information not found + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '500': + description: Internal server error + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + '503': + description: Resource is not available + content: + "application/json": + schema: + "$ref": "#/components/schemas/Response" + deprecated: false components: securitySchemes: OAuth2: @@ -833,4 +920,3 @@ components: type: string description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. ''KGS'' - kilograms.' - From f9265e45f4340ed42821c0a4385ffc8057802f06 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 20 Jan 2026 09:54:01 -0500 Subject: [PATCH 36/89] Update --- Rating.yaml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Rating.yaml b/Rating.yaml index fcf03c2..24c4925 100644 --- a/Rating.yaml +++ b/Rating.yaml @@ -11,8 +11,9 @@ info: - Appendix - Errors - FAQ - - Best Practices - + - Best Practices + - Accelerate API Integration with UPS MCP Server +

Try out UPS APIs with example requests using Postman and learn more about the UPS Postman Collection by visiting our Postman Guide. Explore API documentation and sample applications through GitHub.

@@ -1907,6 +1908,10 @@ components: only for HazMat request and with subversion greater than or equal to 1701. maximum: 1 type: string + ShipmentDate: + description: Shipment date. If a ShipmentDate is not provided, it will be defaulted to the current system date.Valid value "yyyyMMdd". + maximum: 1 + type: string Shipper: "$ref": "#/components/schemas/Shipment_Shipper" ShipTo: @@ -5978,6 +5983,3 @@ components: type: string description: The error message. description: The error response containing any errors that occurred. - - - From 97c4e92da6d221956cdf017e9b15df7a236873a8 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 21 Jan 2026 14:29:47 -0500 Subject: [PATCH 37/89] added V2 version --- CustomsDetailsV2.yaml | 1253 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1253 insertions(+) create mode 100644 CustomsDetailsV2.yaml diff --git a/CustomsDetailsV2.yaml b/CustomsDetailsV2.yaml new file mode 100644 index 0000000..a0e5099 --- /dev/null +++ b/CustomsDetailsV2.yaml @@ -0,0 +1,1253 @@ +openapi: 3.1.0 +info: + title: Customs Detail + version: "1.0" + description: > + Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. + + **Key Business Values:** + - Ensures clients always receive the latest compliance requirements. + - Allows field collection to be fully managed through configurable user settings. + - Flexible framework eliminates additional code changes as compliance fields evolve. + - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. +servers: + - url: https://www.livesite.ups.com/trade/compliance/{version} + description: URL for JWT based authentication that can be used for any environment (production, staging, product test) via hosts file. + variables: + version: + default: v2 + enum: + - v2 + - url: https://onlinetools.ups.com/api/trade/compliance/{version} + description: URL for Oauth based authentication that can be used for any environment (production, staging, product test) via hosts file. + variables: + version: + default: v2 + enum: + - v2 + - url: https://wwwcie.ups.com/api/trade/compliance/{version} + description: UPS Production CIE + variables: + version: + default: v2 + enum: + - v2 +tags: + - name: Field Data + description: Endpoints related to the required fields +paths: + /content/fields/country-fields: + post: + summary: Validate and/or Submit the Fields + description: This endpoint will provide the ability to validate and/or submit the additional field information for a shipment + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - name: registrationId + in: header + required: false + schema: + type: string + description: Used to confirm prsence of active account for Worldship clients + example: 3DA124234342 + operationId: postCountryFieldData + security: + - oauth2: [] + - oauthCie: [] + - JWTAuth: [] + tags: + - Field Data + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CountryFieldsPostFieldsRequestV2" + example: + actionType: save + shipperNumber: 1443YY + trackingNumber: 1Z1443YY0161231327 + shipmentMetaData: + - groupKey: US-IMP-CDC + fields: + - fieldKey: ImportLicenseNumber + regulationSections: + - sectionKey: Bio + fieldValue: "123412351234123" + - groupKey: IN-EXP-CSB + fields: + - fieldKey: CSBType + regulationSections: + - sectionKey: CSB + fieldValue: "3" + - fieldKey: IECCode + regulationSections: + - sectionKey: CSB + fieldValue: "99" + products: + - productId: PART-001 + productDescription: Medical device + commodityCode: "3821000010" + productMetaData: + - groupKey: IN-EXP-CSB + fields: + - fieldKey: Amount + regulationSections: + - sectionKey: CSB + fieldValue: "10" + - fieldKey: CurrencyCode + regulationSections: + - sectionKey: CSB + fieldValue: USD + - groupKey: US-IMP-FDA + fields: + - fieldKey: MnuNa + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: UPS Labs + - fieldKey: MnuAdLn1Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "55 Glenlake Pkwy NE" + - fieldKey: MnuAdLn2Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Suite 400" + - fieldKey: MnuAdLn3Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Building C" + - fieldKey: MnuCtyNa + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Atlanta" + - fieldKey: MnuStPrvCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "GA" + - fieldKey: MnuCtyCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "US" + - fieldKey: MnuPslCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "30301" + - productId: PART-002 + productDescription: Sample pharma goods + commodityCode: "300490" + productMetaData: + - groupKey: US-IMP-FDA + fields: + - fieldKey: MnuNa + regulationSections: + - sectionKey: Cos + fieldValue: UPS Labs + - fieldKey: MnuPslCd + regulationSections: + - sectionKey: Cos + fieldValue: "30301" + - fieldKey: MnuAdLn1Te + regulationSections: + - sectionKey: Cos + fieldValue: 55 Glenlake Pkwy NE + - fieldKey: MnuCtyNa + regulationSections: + - sectionKey: Cos + fieldValue: Atlanta + - fieldKey: MnuStPrvCd + regulationSections: + - sectionKey: Cos + fieldValue: GA + - fieldKey: MnuCtyCd + regulationSections: + - sectionKey: Cos + fieldValue: US + responses: + "204": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + "400": + $ref: '#/components/responses/BadRequest' + "401": + $ref: '#/components/responses/Unauthorized' + "422": + $ref: '#/components/responses/UnprocessableEntity' + "500": + $ref: '#/components/responses/ServerError' + get: + summary: Returns Required Country Fields + description: This returns an array of fields that are required for the provided import and/or export country + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - name: import_country_code + in: query + required: false + schema: + type: + - string + - "null" + description: | + The ISO 3166 country or territory code + from where the shipment is being imported to. If this is omitted then all import fields for all countries will be returned + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: US + - name: export_country_code + in: query + required: false + schema: + type: + - string + - "null" + description: | + The ISO 3166 country or territory code + from where the shipment is being exported from. If this is omitted then all export fields for all countries will be returned + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: IT + - name: locale + in: query + required: false + schema: + type: string + description: "" + minLength: 5 + maxLength: 5 + pattern: ^[a-z]{2}-[A-Z]{2}$ + default: en-US + example: en-US + - name: commodity_codes + in: query + required: false + description: Optional comma-separated list of tariff codes to filter results. + schema: + type: + - string + - "null" + minLength: 1 + maxLength: 2000 + example: "2926400000,3003395000" + operationId: getCountryFieldData + security: + - oauth2: [] + - oauthCie: [] + - JWTAuth: [] + tags: + - Field Data + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: "#/components/schemas/CountryFieldsGetFieldsSuccessResponseV2" + example: + commodityCodes: + - commodityCode: "2926400000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + - commodityCode: "3003395000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + fieldGroups: + - countryCode: US + countryName: UNITED STATES OF AMERICA + shipmentType: Import + groupKey: US-IMP-FDA + details: This is for US import FDA fields + regulation: FDA + regulationSections: + - sectionKey: Cos + sectionName: Cosmetics + - sectionKey: Bio + sectionName: Biologics + - sectionKey: Dev + sectionName: Device + - sectionKey: Foo + sectionName: Food + fields: + - sectionKey: MnuNa + label: Manufacturer Name + order: "1" + tooltip: Type of shipping bill to be processed for the shipment + isRequired: C + requirementConditions: + - fieldKey: MnuPslCd + operator: "!=" + value: "" + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerName + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "8" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + - sectionKey: MnuAdLn1Te + label: Manufacturer Address Line 1 + order: "1" + tooltip: Line 1 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine1 + level: Product + - sectionKey: MnuAdLn2Te + label: Manufacturer Address Line 2 + order: "1" + tooltip: Line 2 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine2 + level: Product + - sectionKey: MnuAdLn3Te + label: Manufacturer Address Line 3 + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuCtyNa + label: Manufacturer City Name + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuStPrvCd + label: Manufacturer State/Province Code + order: "1" + tooltip: The state/province for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerStateProvinceCode + level: Product + - sectionKey: MnuCtyCd + label: Manufacturer Country Code + order: "1" + tooltip: The country code for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerCountryCode + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "1" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + "401": + $ref: '#/components/responses/Unauthorized' + "422": + $ref: '#/components/responses/UnprocessableEntity' + "500": + $ref: '#/components/responses/ServerError' +components: + securitySchemes: + oauth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token + scopes: {} + oauthCie: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + JWTAuth: + type: "http" + scheme: bearer + bearerFormat: JWT + parameters: + transId: + name: transId + in: header + required: true + schema: + type: string + description: Transaction Id + transactionSrc: + name: transactionSrc + in: header + required: true + schema: + type: string + description: Identifies the clients/source application that is calling + Content-Type: + name: Content-Type + in: header + required: true + schema: + type: string + description: accepted value application/json + headers: + BkndTransId: + description: The backend transaction id. + schema: + type: string + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]+$ + maxLength: 512 + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]+$ + maxLength: 512 + example: UPS.com + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + schema: + type: string + example: UJ0001 + APIErrorMsg: + description: The API error message. + schema: + type: string + example: Invalid token or token is not present. + responses: + BadRequest: + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + example: + response: + errors: + - code: "105.000" + message: Malformed JSON request + - code: "105.004" + message: Field value is required + description: "VALUE_REQUIRED" + field: "shipperNumber" + value: null + Unauthorized: + description: Unauthorized + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + example: + response: + errors: + - code: "105.401" + message: Invalid token or token is not present + description: null + field: null + value: null + UnprocessableEntity: + description: Unprocessable Entity + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/CountryFieldsErrorResponseV2" + example: + response: + errors: + - code: "105.001" + description: INVALID_FIELD + field: importCountryCode + message: Supplied value was not in the correct range of valid values. + value: USA + ServerError: + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + example: + response: + errors: + - code: "105.500" + message: Internal Server Error + description: INTERNAL_ERROR + field: null + value: null + schemas: + #/content/fields/country-fields + CountryFieldsPostFieldsRequestV2: + type: object + description: Container for the posting of field data + properties: + shipperNumber: + type: string + description: This represents the shipper account number. Required when actionType is save. + minLength: 6 + maxLength: 6 + example: X5R660 + actionType: + type: string + description: Specify the intent of the request. 'Save' will inherently perform validation. + enum: + - validate + - save + trackingNumber: + type: string + description: Tthe lead 1Z number fore the shipment. Required when actionType is save. + minLength: 18 + maxLength: 18 + pattern: ^1Z[0-9A-Z]{16}$ + example: 1Z1234567891234560 + shipmentMetaData: + $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' + products: + type: array + description: Unbounded list of containers for products included on the shipment being updated + minItems: 1 + items: + type: object + properties: + productId: + type: string + description: An identifier for the product + minLength: 1 + maxLength: 50 + example: PROD-001 + productDescription: + type: string + description: The description of the product + minLength: 1 + maxLength: 105 + example: Sample pharma goods + commodityCode: + $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' + productMetaData: + $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' + additionalProperties: false + required: + - productId + - productDescription + - productMetaData + additionalProperties: false + required: + - actionType + CountryFieldsGetFieldsSuccessResponseV2: + type: object + description: Contains commodity code groupings and the detailed field metadata required per country, process, and Regulation. + properties: + commodityCodes: + type: array + description: Unbounded list of commodity codes and their associated compliance Regulations. + items: + type: object + properties: + commodityCode: + $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' + regulations: + type: array + description: Regulations that require additional data for this commodity code. + minItems: 1 + items: + type: object + properties: + regulation: + $ref: '#/components/schemas/CountryFieldsRegulationV2' + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + additionalProperties: false + required: + - regulation + - regulationSections + additionalProperties: false + required: + - commodityCode + - regulations + fieldGroups: + type: array + description: Unbounded list of field group definitions grouped by country, shipment type, and Regulation. + minItems: 1 + items: + type: object + properties: + countryCode: + type: string + description: The ISO 3166 country or territory code the fields pertain to. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: US + countryName: + type: string + description: Country name the fields apply to. + example: UNITED STATES OF AMERICA + shipmentType: + type: string + description: Indicates what direction of movement the fields pertain to. + oneOf: + - title: Fields for import movment + const: Import + - title: Fields for export movement + const: Export + - title: Fields for both movements + const: Both + groupKey: + $ref: '#/components/schemas/CountryFieldsGroupKeyV2' + details: + type: string + description: Provides details on why and when the information is needed. + example: This is for US import FDA fields + regulation: + $ref: '#/components/schemas/CountryFieldsRegulationV2' + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + fields: + type: array + description: Unbounded list of individual field definitions. + minItems: 1 + items: + type: object + properties: + sectionKey: + $ref: '#/components/schemas/CountryFieldsSectionKeyV2' + label: + type: string + description: Human-readable name of the field. + example: Manufacturer Name + order: + type: string + description: Display order for the field. + minLength: 1 + maxLength: 3 + example: "1" + tooltip: + type: + - string + - "null" + description: Tooltip text explaining the field. + example: The name of the manufacturer for the product + isRequired: + type: string + description: Returns the conditionality of the field + oneOf: + - title: "Yes" + const: "Y" + - title: "No" + const: "N" + - title: "Conditional" + description: "If returned there will be at least one requirement condition" + const: "C" + requirementConditions: + type: + - array + - "null" + description: Unbounded array of rules. Conditionally required when is 'isRequired' flag is set. + items: + type: object + description: | + An object containing the specifics of each rule. Order is to be applied + top-down (OR conditions align with the prior rule). + properties: + logicalOperator: + type: string + description: | + Determines how the rules are joined when evaluating the condition if there are multiple rules. + Required for all rules except the first. + enum: + - "AND" + - "OR" + fieldKey: + type: + - string + - "null" + description: The key for the field that this rule is evaluating + example: IN001 + operator: + type: + - string + - "null" + description: The operator used when evaluating the rule + oneOf: + - title: Equals + const: "=" + - title: Greater Than + const: ">" + - title: Less Than + const: "<" + - title: Not Equal To + const: "!=" + value: + type: + - string + - "null" + description: The value used when evaluating the rule + example: CSB V + additionalProperties: false + required: + - fieldKey + - operator + - value + fieldType: + type: string + description: The type of the field, based on available html form inputs + enum: + - textbox + - list + - date + - radio + - checkbox + - textarea + example: textbox + allowedValueCount: + type: integer + description: Number of occurnces allowed for this field + minLength: 1 + maxLength: 2 + default: 1 + example: 1 + validation: + type: object + description: rule validation object + properties: + minLength: + type: + - integer + - "null" + description: The min length allowed for text fields + minLength: 1 + maxLength: 2 + minimum: 1 + maximum: 99 + example: 1 + maxLength: + type: + - integer + - "null" + description: The max length allowed for text fields + minLength: 1 + maxLength: 3 + minimum: 1 + maximum: 100 + example: 10 + errorMessage: + type: + - string + - "null" + description: Error Message + example: Enter a valid alpha numeric value. + dataType: + type: string + description: defines which type of values to look for + oneOf: + - title: Custom + description: user will be required to enter a custom regex pattern + const: Custom + - title: List + description: listValues will need to be populated with a list of possible values for the field + const: List + - title: Email + const: Email + - title: Text + const: Text + - title: Alphanumeric + const: Alphanumeric + - title: Number + const: Number + - title: Date + const: Date + regexPattern: + type: + - string + - "null" + description: | + A regex-based validation pattern for the field which should be applied when validating, + Required when the type is 'custom'. + example: ^[a-zA-Z0-9]+$ + listValues: + type: array + description: Unbounded list of string values to validate against. Required for type 'List' + items: + type: object + description: value to validate against + properties: + displayText: + type: string + description: Value to display in the dropdown for consumers + examples: + - GSTIN (Normal) + - GSTIN (Govt Entities) + - GSTIN (Diplomats) + - PAN Number + - TAN Number + - Passport Number + - Aadhaar Number + - Voter Id + internalValue: + type: string + description: Internal value for each dropdown item that is hidden to consumers + examples: + - GSTIN + - GSTINGE + - GSTIND + - PANNO + - TANNO + - PASSNO + - AADHAARNO + - VID + additionalProperties: false + required: + - displayText + - internalValue + additionalProperties: false + required: + - minLength + - maxLength + - errorMessage + - dataType + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + keyAlias: + type: + - string + - "null" + description: Alias used to identify the field when mapping to downstream systems. + example: ManufacturerName + level: + type: + - string + - "null" + description: Indicates whether the field applies at the shipment or product level. + enum: + - Shipment + - Product + example: Product + additionalProperties: false + required: + - order + - sectionKey + - label + - tooltip + - isRequired + - fieldType + - allowedValueCount + - validation + - regulationSections + additionalProperties: false + additionalProperties: false + required: + - countryCode + - shipmentType + - groupKey + - details + - regulation + - regulationSections + - fields + additionalProperties: false + required: + - commodityCodes + + #COMMON + CountryFieldsCommodityCodeV2: + type: string + description: The tariff code for the product for the selected country and process type + minLength: 1 + maxLength: 15 + example: "300490" + CountryFieldsGroupKeyV2: + type: string + description: Field group key returned by the GET endpoint used to scope the shipment metadata payload. + minLength: 1 + maxLength: 50 + example: US-IMP-CDC + CountryFieldsRequestMetaDataV2: + type: array + description: Unbounded list of containers for product metadata groups + minItems: 1 + items: + type: object + properties: + groupKey: + $ref: '#/components/schemas/CountryFieldsGroupKeyV2' + fields: + type: array + description: Unbounded list of key-value pairs describing product fields + minItems: 1 + items: + type: object + properties: + fieldKey: + type: string + description: Identifier for the field. + minLength: 1 + maxLength: 50 + examples: + - ImportLicenseNumber + - CSBType + - IECCode + - Amount + - CurrencyCode + - MnuNa + - MnuAdLn1Te + - MnuAdLn2Te + - MnuAdLn3Te + - MnuCtyNa + - MnuStPrvCd + - MnuCtyCd + - MnuPslCd + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + fieldValue: + type: string + description: Value of the field + minLength: 0 + maxLength: 500 + example: UPS Labs + additionalProperties: false + required: + - fieldKey + - regulationSections + - fieldValue + additionalProperties: false + required: + - fields + CountryFieldsSectionKeyV2: + type: string + description: Identifier for the field. + minLength: 1 + maxLength: 50 + examples: + - Bio + - CSB + - Cos + - Dev + - Foo + CountryFieldsRegulationV2: + type: string + description: Identifier for the compliance Regulation. + minLength: 1 + maxLength: 50 + example: FDA + CountryFieldsRegulationSectionV2: + type: array + description: Unbounded list of regulationSection definitions for this Regulation. + minItems: 1 + items: + type: object + properties: + sectionKey: + description: Identifier for the field. Conditionaly required when sectionName is not present. + $ref: '#/components/schemas/CountryFieldsSectionKeyV2' + sectionName: + type: string + description: Human-readable regulationSection label. Conditionally required when sectionKey is not present. + minLength: 1 + maxLength: 100 + example: Cosmetics + additionalProperties: false + CountryFieldsErrorResponseV2: + type: object + description: Response object for errors + properties: + response: + description: Response container to store errors + type: object + properties: + errors: + type: array + description: Unbounded array containing one or more errors + items: + type: object + description: Error entity + properties: + code: + type: string + description: code for the given message + minLength: 1 + example: "105.002" + message: + type: string + description: the warning or error message to be conveyed + minLength: 1 + example: Supplied Key was not in the correct range. + description: + type: + - string + - "null" + description: Internal description of the error + minLength: 1 + example: INVALID_KEY + field: + type: + - string + - "null" + description: The path to the field causing the error as returned from the backend services. + minLength: 1 + example: shipperNumber + value: + type: + - string + - "null" + description: The value that caused the error + minLength: 1 + example: "789999" + additionalProperties: false + required: + - code + - message + required: + - errors + additionalProperties: false + required: + - response + additionalProperties: false From 6e1f732246f95882de59f995cf755a8c9d1fae80 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 21 Jan 2026 14:37:59 -0500 Subject: [PATCH 38/89] Update --- CustomsDetailsV2.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CustomsDetailsV2.yaml b/CustomsDetailsV2.yaml index a0e5099..b9ed45f 100644 --- a/CustomsDetailsV2.yaml +++ b/CustomsDetailsV2.yaml @@ -5,7 +5,7 @@ info: description: > Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. - **Key Business Values:** + ## Key Business Values - Ensures clients always receive the latest compliance requirements. - Allows field collection to be fully managed through configurable user settings. - Flexible framework eliminates additional code changes as compliance fields evolve. From 7885a77770d4d03629422be511fe6986aab43e2a Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 21 Jan 2026 14:56:28 -0500 Subject: [PATCH 39/89] Delete CustomsDetailsV2.yaml --- CustomsDetailsV2.yaml | 1253 ----------------------------------------- 1 file changed, 1253 deletions(-) delete mode 100644 CustomsDetailsV2.yaml diff --git a/CustomsDetailsV2.yaml b/CustomsDetailsV2.yaml deleted file mode 100644 index b9ed45f..0000000 --- a/CustomsDetailsV2.yaml +++ /dev/null @@ -1,1253 +0,0 @@ -openapi: 3.1.0 -info: - title: Customs Detail - version: "1.0" - description: > - Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. - - ## Key Business Values - - Ensures clients always receive the latest compliance requirements. - - Allows field collection to be fully managed through configurable user settings. - - Flexible framework eliminates additional code changes as compliance fields evolve. - - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. -servers: - - url: https://www.livesite.ups.com/trade/compliance/{version} - description: URL for JWT based authentication that can be used for any environment (production, staging, product test) via hosts file. - variables: - version: - default: v2 - enum: - - v2 - - url: https://onlinetools.ups.com/api/trade/compliance/{version} - description: URL for Oauth based authentication that can be used for any environment (production, staging, product test) via hosts file. - variables: - version: - default: v2 - enum: - - v2 - - url: https://wwwcie.ups.com/api/trade/compliance/{version} - description: UPS Production CIE - variables: - version: - default: v2 - enum: - - v2 -tags: - - name: Field Data - description: Endpoints related to the required fields -paths: - /content/fields/country-fields: - post: - summary: Validate and/or Submit the Fields - description: This endpoint will provide the ability to validate and/or submit the additional field information for a shipment - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/transactionSrc" - - $ref: "#/components/parameters/Content-Type" - - name: registrationId - in: header - required: false - schema: - type: string - description: Used to confirm prsence of active account for Worldship clients - example: 3DA124234342 - operationId: postCountryFieldData - security: - - oauth2: [] - - oauthCie: [] - - JWTAuth: [] - tags: - - Field Data - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsPostFieldsRequestV2" - example: - actionType: save - shipperNumber: 1443YY - trackingNumber: 1Z1443YY0161231327 - shipmentMetaData: - - groupKey: US-IMP-CDC - fields: - - fieldKey: ImportLicenseNumber - regulationSections: - - sectionKey: Bio - fieldValue: "123412351234123" - - groupKey: IN-EXP-CSB - fields: - - fieldKey: CSBType - regulationSections: - - sectionKey: CSB - fieldValue: "3" - - fieldKey: IECCode - regulationSections: - - sectionKey: CSB - fieldValue: "99" - products: - - productId: PART-001 - productDescription: Medical device - commodityCode: "3821000010" - productMetaData: - - groupKey: IN-EXP-CSB - fields: - - fieldKey: Amount - regulationSections: - - sectionKey: CSB - fieldValue: "10" - - fieldKey: CurrencyCode - regulationSections: - - sectionKey: CSB - fieldValue: USD - - groupKey: US-IMP-FDA - fields: - - fieldKey: MnuNa - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: UPS Labs - - fieldKey: MnuAdLn1Te - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "55 Glenlake Pkwy NE" - - fieldKey: MnuAdLn2Te - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "Suite 400" - - fieldKey: MnuAdLn3Te - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "Building C" - - fieldKey: MnuCtyNa - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "Atlanta" - - fieldKey: MnuStPrvCd - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "GA" - - fieldKey: MnuCtyCd - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "US" - - fieldKey: MnuPslCd - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "30301" - - productId: PART-002 - productDescription: Sample pharma goods - commodityCode: "300490" - productMetaData: - - groupKey: US-IMP-FDA - fields: - - fieldKey: MnuNa - regulationSections: - - sectionKey: Cos - fieldValue: UPS Labs - - fieldKey: MnuPslCd - regulationSections: - - sectionKey: Cos - fieldValue: "30301" - - fieldKey: MnuAdLn1Te - regulationSections: - - sectionKey: Cos - fieldValue: 55 Glenlake Pkwy NE - - fieldKey: MnuCtyNa - regulationSections: - - sectionKey: Cos - fieldValue: Atlanta - - fieldKey: MnuStPrvCd - regulationSections: - - sectionKey: Cos - fieldValue: GA - - fieldKey: MnuCtyCd - regulationSections: - - sectionKey: Cos - fieldValue: US - responses: - "204": - description: Success - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - "400": - $ref: '#/components/responses/BadRequest' - "401": - $ref: '#/components/responses/Unauthorized' - "422": - $ref: '#/components/responses/UnprocessableEntity' - "500": - $ref: '#/components/responses/ServerError' - get: - summary: Returns Required Country Fields - description: This returns an array of fields that are required for the provided import and/or export country - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/transactionSrc" - - $ref: "#/components/parameters/Content-Type" - - name: import_country_code - in: query - required: false - schema: - type: - - string - - "null" - description: | - The ISO 3166 country or territory code - from where the shipment is being imported to. If this is omitted then all import fields for all countries will be returned - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: US - - name: export_country_code - in: query - required: false - schema: - type: - - string - - "null" - description: | - The ISO 3166 country or territory code - from where the shipment is being exported from. If this is omitted then all export fields for all countries will be returned - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: IT - - name: locale - in: query - required: false - schema: - type: string - description: "" - minLength: 5 - maxLength: 5 - pattern: ^[a-z]{2}-[A-Z]{2}$ - default: en-US - example: en-US - - name: commodity_codes - in: query - required: false - description: Optional comma-separated list of tariff codes to filter results. - schema: - type: - - string - - "null" - minLength: 1 - maxLength: 2000 - example: "2926400000,3003395000" - operationId: getCountryFieldData - security: - - oauth2: [] - - oauthCie: [] - - JWTAuth: [] - tags: - - Field Data - responses: - "200": - description: Success - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsGetFieldsSuccessResponseV2" - example: - commodityCodes: - - commodityCode: "2926400000" - regulations: - - regulation: FDA - regulationSections: - - sectionKey: DRU - - commodityCode: "3003395000" - regulations: - - regulation: FDA - regulationSections: - - sectionKey: DRU - fieldGroups: - - countryCode: US - countryName: UNITED STATES OF AMERICA - shipmentType: Import - groupKey: US-IMP-FDA - details: This is for US import FDA fields - regulation: FDA - regulationSections: - - sectionKey: Cos - sectionName: Cosmetics - - sectionKey: Bio - sectionName: Biologics - - sectionKey: Dev - sectionName: Device - - sectionKey: Foo - sectionName: Food - fields: - - sectionKey: MnuNa - label: Manufacturer Name - order: "1" - tooltip: Type of shipping bill to be processed for the shipment - isRequired: C - requirementConditions: - - fieldKey: MnuPslCd - operator: "!=" - value: "" - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerName - level: Product - - sectionKey: MnuPslCd - label: Manufacturer Postal Code - order: "8" - tooltip: The postal code address of the manufacturer for the product - isRequired: Y - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerPostalCode - level: Product - - sectionKey: MnuAdLn1Te - label: Manufacturer Address Line 1 - order: "1" - tooltip: Line 1 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine1 - level: Product - - sectionKey: MnuAdLn2Te - label: Manufacturer Address Line 2 - order: "1" - tooltip: Line 2 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine2 - level: Product - - sectionKey: MnuAdLn3Te - label: Manufacturer Address Line 3 - order: "1" - tooltip: Line 3 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine3 - level: Product - - sectionKey: MnuCtyNa - label: Manufacturer City Name - order: "1" - tooltip: Line 3 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine3 - level: Product - - sectionKey: MnuStPrvCd - label: Manufacturer State/Province Code - order: "1" - tooltip: The state/province for the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerStateProvinceCode - level: Product - - sectionKey: MnuCtyCd - label: Manufacturer Country Code - order: "1" - tooltip: The country code for the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerCountryCode - level: Product - - sectionKey: MnuPslCd - label: Manufacturer Postal Code - order: "1" - tooltip: The postal code address of the manufacturer for the product - isRequired: Y - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerPostalCode - level: Product - "401": - $ref: '#/components/responses/Unauthorized' - "422": - $ref: '#/components/responses/UnprocessableEntity' - "500": - $ref: '#/components/responses/ServerError' -components: - securitySchemes: - oauth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token - scopes: {} - oauthCie: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - JWTAuth: - type: "http" - scheme: bearer - bearerFormat: JWT - parameters: - transId: - name: transId - in: header - required: true - schema: - type: string - description: Transaction Id - transactionSrc: - name: transactionSrc - in: header - required: true - schema: - type: string - description: Identifies the clients/source application that is calling - Content-Type: - name: Content-Type - in: header - required: true - schema: - type: string - description: accepted value application/json - headers: - BkndTransId: - description: The backend transaction id. - schema: - type: string - example: 383f7d397a48 - transId: - description: An identifier unique to the request. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]+$ - maxLength: 512 - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - description: Identifies the client/source application that is calling. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]+$ - maxLength: 512 - example: UPS.com - Content-Type: - description: The Content-Type header provides the client with the actual content/media type of the returned content. - schema: - type: string - example: application/json - APIErrorCode: - description: The API error code. - schema: - type: string - example: UJ0001 - APIErrorMsg: - description: The API error message. - schema: - type: string - example: Invalid token or token is not present. - responses: - BadRequest: - description: Bad Request - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/CountryFieldsErrorResponseV2' - example: - response: - errors: - - code: "105.000" - message: Malformed JSON request - - code: "105.004" - message: Field value is required - description: "VALUE_REQUIRED" - field: "shipperNumber" - value: null - Unauthorized: - description: Unauthorized - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/CountryFieldsErrorResponseV2' - example: - response: - errors: - - code: "105.401" - message: Invalid token or token is not present - description: null - field: null - value: null - UnprocessableEntity: - description: Unprocessable Entity - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsErrorResponseV2" - example: - response: - errors: - - code: "105.001" - description: INVALID_FIELD - field: importCountryCode - message: Supplied value was not in the correct range of valid values. - value: USA - ServerError: - description: Server Error - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/CountryFieldsErrorResponseV2' - example: - response: - errors: - - code: "105.500" - message: Internal Server Error - description: INTERNAL_ERROR - field: null - value: null - schemas: - #/content/fields/country-fields - CountryFieldsPostFieldsRequestV2: - type: object - description: Container for the posting of field data - properties: - shipperNumber: - type: string - description: This represents the shipper account number. Required when actionType is save. - minLength: 6 - maxLength: 6 - example: X5R660 - actionType: - type: string - description: Specify the intent of the request. 'Save' will inherently perform validation. - enum: - - validate - - save - trackingNumber: - type: string - description: Tthe lead 1Z number fore the shipment. Required when actionType is save. - minLength: 18 - maxLength: 18 - pattern: ^1Z[0-9A-Z]{16}$ - example: 1Z1234567891234560 - shipmentMetaData: - $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' - products: - type: array - description: Unbounded list of containers for products included on the shipment being updated - minItems: 1 - items: - type: object - properties: - productId: - type: string - description: An identifier for the product - minLength: 1 - maxLength: 50 - example: PROD-001 - productDescription: - type: string - description: The description of the product - minLength: 1 - maxLength: 105 - example: Sample pharma goods - commodityCode: - $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' - productMetaData: - $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' - additionalProperties: false - required: - - productId - - productDescription - - productMetaData - additionalProperties: false - required: - - actionType - CountryFieldsGetFieldsSuccessResponseV2: - type: object - description: Contains commodity code groupings and the detailed field metadata required per country, process, and Regulation. - properties: - commodityCodes: - type: array - description: Unbounded list of commodity codes and their associated compliance Regulations. - items: - type: object - properties: - commodityCode: - $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' - regulations: - type: array - description: Regulations that require additional data for this commodity code. - minItems: 1 - items: - type: object - properties: - regulation: - $ref: '#/components/schemas/CountryFieldsRegulationV2' - regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' - additionalProperties: false - required: - - regulation - - regulationSections - additionalProperties: false - required: - - commodityCode - - regulations - fieldGroups: - type: array - description: Unbounded list of field group definitions grouped by country, shipment type, and Regulation. - minItems: 1 - items: - type: object - properties: - countryCode: - type: string - description: The ISO 3166 country or territory code the fields pertain to. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: US - countryName: - type: string - description: Country name the fields apply to. - example: UNITED STATES OF AMERICA - shipmentType: - type: string - description: Indicates what direction of movement the fields pertain to. - oneOf: - - title: Fields for import movment - const: Import - - title: Fields for export movement - const: Export - - title: Fields for both movements - const: Both - groupKey: - $ref: '#/components/schemas/CountryFieldsGroupKeyV2' - details: - type: string - description: Provides details on why and when the information is needed. - example: This is for US import FDA fields - regulation: - $ref: '#/components/schemas/CountryFieldsRegulationV2' - regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' - fields: - type: array - description: Unbounded list of individual field definitions. - minItems: 1 - items: - type: object - properties: - sectionKey: - $ref: '#/components/schemas/CountryFieldsSectionKeyV2' - label: - type: string - description: Human-readable name of the field. - example: Manufacturer Name - order: - type: string - description: Display order for the field. - minLength: 1 - maxLength: 3 - example: "1" - tooltip: - type: - - string - - "null" - description: Tooltip text explaining the field. - example: The name of the manufacturer for the product - isRequired: - type: string - description: Returns the conditionality of the field - oneOf: - - title: "Yes" - const: "Y" - - title: "No" - const: "N" - - title: "Conditional" - description: "If returned there will be at least one requirement condition" - const: "C" - requirementConditions: - type: - - array - - "null" - description: Unbounded array of rules. Conditionally required when is 'isRequired' flag is set. - items: - type: object - description: | - An object containing the specifics of each rule. Order is to be applied - top-down (OR conditions align with the prior rule). - properties: - logicalOperator: - type: string - description: | - Determines how the rules are joined when evaluating the condition if there are multiple rules. - Required for all rules except the first. - enum: - - "AND" - - "OR" - fieldKey: - type: - - string - - "null" - description: The key for the field that this rule is evaluating - example: IN001 - operator: - type: - - string - - "null" - description: The operator used when evaluating the rule - oneOf: - - title: Equals - const: "=" - - title: Greater Than - const: ">" - - title: Less Than - const: "<" - - title: Not Equal To - const: "!=" - value: - type: - - string - - "null" - description: The value used when evaluating the rule - example: CSB V - additionalProperties: false - required: - - fieldKey - - operator - - value - fieldType: - type: string - description: The type of the field, based on available html form inputs - enum: - - textbox - - list - - date - - radio - - checkbox - - textarea - example: textbox - allowedValueCount: - type: integer - description: Number of occurnces allowed for this field - minLength: 1 - maxLength: 2 - default: 1 - example: 1 - validation: - type: object - description: rule validation object - properties: - minLength: - type: - - integer - - "null" - description: The min length allowed for text fields - minLength: 1 - maxLength: 2 - minimum: 1 - maximum: 99 - example: 1 - maxLength: - type: - - integer - - "null" - description: The max length allowed for text fields - minLength: 1 - maxLength: 3 - minimum: 1 - maximum: 100 - example: 10 - errorMessage: - type: - - string - - "null" - description: Error Message - example: Enter a valid alpha numeric value. - dataType: - type: string - description: defines which type of values to look for - oneOf: - - title: Custom - description: user will be required to enter a custom regex pattern - const: Custom - - title: List - description: listValues will need to be populated with a list of possible values for the field - const: List - - title: Email - const: Email - - title: Text - const: Text - - title: Alphanumeric - const: Alphanumeric - - title: Number - const: Number - - title: Date - const: Date - regexPattern: - type: - - string - - "null" - description: | - A regex-based validation pattern for the field which should be applied when validating, - Required when the type is 'custom'. - example: ^[a-zA-Z0-9]+$ - listValues: - type: array - description: Unbounded list of string values to validate against. Required for type 'List' - items: - type: object - description: value to validate against - properties: - displayText: - type: string - description: Value to display in the dropdown for consumers - examples: - - GSTIN (Normal) - - GSTIN (Govt Entities) - - GSTIN (Diplomats) - - PAN Number - - TAN Number - - Passport Number - - Aadhaar Number - - Voter Id - internalValue: - type: string - description: Internal value for each dropdown item that is hidden to consumers - examples: - - GSTIN - - GSTINGE - - GSTIND - - PANNO - - TANNO - - PASSNO - - AADHAARNO - - VID - additionalProperties: false - required: - - displayText - - internalValue - additionalProperties: false - required: - - minLength - - maxLength - - errorMessage - - dataType - regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' - keyAlias: - type: - - string - - "null" - description: Alias used to identify the field when mapping to downstream systems. - example: ManufacturerName - level: - type: - - string - - "null" - description: Indicates whether the field applies at the shipment or product level. - enum: - - Shipment - - Product - example: Product - additionalProperties: false - required: - - order - - sectionKey - - label - - tooltip - - isRequired - - fieldType - - allowedValueCount - - validation - - regulationSections - additionalProperties: false - additionalProperties: false - required: - - countryCode - - shipmentType - - groupKey - - details - - regulation - - regulationSections - - fields - additionalProperties: false - required: - - commodityCodes - - #COMMON - CountryFieldsCommodityCodeV2: - type: string - description: The tariff code for the product for the selected country and process type - minLength: 1 - maxLength: 15 - example: "300490" - CountryFieldsGroupKeyV2: - type: string - description: Field group key returned by the GET endpoint used to scope the shipment metadata payload. - minLength: 1 - maxLength: 50 - example: US-IMP-CDC - CountryFieldsRequestMetaDataV2: - type: array - description: Unbounded list of containers for product metadata groups - minItems: 1 - items: - type: object - properties: - groupKey: - $ref: '#/components/schemas/CountryFieldsGroupKeyV2' - fields: - type: array - description: Unbounded list of key-value pairs describing product fields - minItems: 1 - items: - type: object - properties: - fieldKey: - type: string - description: Identifier for the field. - minLength: 1 - maxLength: 50 - examples: - - ImportLicenseNumber - - CSBType - - IECCode - - Amount - - CurrencyCode - - MnuNa - - MnuAdLn1Te - - MnuAdLn2Te - - MnuAdLn3Te - - MnuCtyNa - - MnuStPrvCd - - MnuCtyCd - - MnuPslCd - regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' - fieldValue: - type: string - description: Value of the field - minLength: 0 - maxLength: 500 - example: UPS Labs - additionalProperties: false - required: - - fieldKey - - regulationSections - - fieldValue - additionalProperties: false - required: - - fields - CountryFieldsSectionKeyV2: - type: string - description: Identifier for the field. - minLength: 1 - maxLength: 50 - examples: - - Bio - - CSB - - Cos - - Dev - - Foo - CountryFieldsRegulationV2: - type: string - description: Identifier for the compliance Regulation. - minLength: 1 - maxLength: 50 - example: FDA - CountryFieldsRegulationSectionV2: - type: array - description: Unbounded list of regulationSection definitions for this Regulation. - minItems: 1 - items: - type: object - properties: - sectionKey: - description: Identifier for the field. Conditionaly required when sectionName is not present. - $ref: '#/components/schemas/CountryFieldsSectionKeyV2' - sectionName: - type: string - description: Human-readable regulationSection label. Conditionally required when sectionKey is not present. - minLength: 1 - maxLength: 100 - example: Cosmetics - additionalProperties: false - CountryFieldsErrorResponseV2: - type: object - description: Response object for errors - properties: - response: - description: Response container to store errors - type: object - properties: - errors: - type: array - description: Unbounded array containing one or more errors - items: - type: object - description: Error entity - properties: - code: - type: string - description: code for the given message - minLength: 1 - example: "105.002" - message: - type: string - description: the warning or error message to be conveyed - minLength: 1 - example: Supplied Key was not in the correct range. - description: - type: - - string - - "null" - description: Internal description of the error - minLength: 1 - example: INVALID_KEY - field: - type: - - string - - "null" - description: The path to the field causing the error as returned from the backend services. - minLength: 1 - example: shipperNumber - value: - type: - - string - - "null" - description: The value that caused the error - minLength: 1 - example: "789999" - additionalProperties: false - required: - - code - - message - required: - - errors - additionalProperties: false - required: - - response - additionalProperties: false From 4197d378769916bbe46122f0e94dc866a8dad0ff Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 21 Jan 2026 14:57:07 -0500 Subject: [PATCH 40/89] added Added OpenAPI specification for Customs Detail API, including endpoints for validating and submitting country fields, and retrieving required fields based on import/export country codes. --- CustomsDetailV2.yaml | 1253 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1253 insertions(+) create mode 100644 CustomsDetailV2.yaml diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml new file mode 100644 index 0000000..b9ed45f --- /dev/null +++ b/CustomsDetailV2.yaml @@ -0,0 +1,1253 @@ +openapi: 3.1.0 +info: + title: Customs Detail + version: "1.0" + description: > + Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. + + ## Key Business Values + - Ensures clients always receive the latest compliance requirements. + - Allows field collection to be fully managed through configurable user settings. + - Flexible framework eliminates additional code changes as compliance fields evolve. + - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. +servers: + - url: https://www.livesite.ups.com/trade/compliance/{version} + description: URL for JWT based authentication that can be used for any environment (production, staging, product test) via hosts file. + variables: + version: + default: v2 + enum: + - v2 + - url: https://onlinetools.ups.com/api/trade/compliance/{version} + description: URL for Oauth based authentication that can be used for any environment (production, staging, product test) via hosts file. + variables: + version: + default: v2 + enum: + - v2 + - url: https://wwwcie.ups.com/api/trade/compliance/{version} + description: UPS Production CIE + variables: + version: + default: v2 + enum: + - v2 +tags: + - name: Field Data + description: Endpoints related to the required fields +paths: + /content/fields/country-fields: + post: + summary: Validate and/or Submit the Fields + description: This endpoint will provide the ability to validate and/or submit the additional field information for a shipment + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - name: registrationId + in: header + required: false + schema: + type: string + description: Used to confirm prsence of active account for Worldship clients + example: 3DA124234342 + operationId: postCountryFieldData + security: + - oauth2: [] + - oauthCie: [] + - JWTAuth: [] + tags: + - Field Data + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CountryFieldsPostFieldsRequestV2" + example: + actionType: save + shipperNumber: 1443YY + trackingNumber: 1Z1443YY0161231327 + shipmentMetaData: + - groupKey: US-IMP-CDC + fields: + - fieldKey: ImportLicenseNumber + regulationSections: + - sectionKey: Bio + fieldValue: "123412351234123" + - groupKey: IN-EXP-CSB + fields: + - fieldKey: CSBType + regulationSections: + - sectionKey: CSB + fieldValue: "3" + - fieldKey: IECCode + regulationSections: + - sectionKey: CSB + fieldValue: "99" + products: + - productId: PART-001 + productDescription: Medical device + commodityCode: "3821000010" + productMetaData: + - groupKey: IN-EXP-CSB + fields: + - fieldKey: Amount + regulationSections: + - sectionKey: CSB + fieldValue: "10" + - fieldKey: CurrencyCode + regulationSections: + - sectionKey: CSB + fieldValue: USD + - groupKey: US-IMP-FDA + fields: + - fieldKey: MnuNa + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: UPS Labs + - fieldKey: MnuAdLn1Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "55 Glenlake Pkwy NE" + - fieldKey: MnuAdLn2Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Suite 400" + - fieldKey: MnuAdLn3Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Building C" + - fieldKey: MnuCtyNa + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Atlanta" + - fieldKey: MnuStPrvCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "GA" + - fieldKey: MnuCtyCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "US" + - fieldKey: MnuPslCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "30301" + - productId: PART-002 + productDescription: Sample pharma goods + commodityCode: "300490" + productMetaData: + - groupKey: US-IMP-FDA + fields: + - fieldKey: MnuNa + regulationSections: + - sectionKey: Cos + fieldValue: UPS Labs + - fieldKey: MnuPslCd + regulationSections: + - sectionKey: Cos + fieldValue: "30301" + - fieldKey: MnuAdLn1Te + regulationSections: + - sectionKey: Cos + fieldValue: 55 Glenlake Pkwy NE + - fieldKey: MnuCtyNa + regulationSections: + - sectionKey: Cos + fieldValue: Atlanta + - fieldKey: MnuStPrvCd + regulationSections: + - sectionKey: Cos + fieldValue: GA + - fieldKey: MnuCtyCd + regulationSections: + - sectionKey: Cos + fieldValue: US + responses: + "204": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + "400": + $ref: '#/components/responses/BadRequest' + "401": + $ref: '#/components/responses/Unauthorized' + "422": + $ref: '#/components/responses/UnprocessableEntity' + "500": + $ref: '#/components/responses/ServerError' + get: + summary: Returns Required Country Fields + description: This returns an array of fields that are required for the provided import and/or export country + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - name: import_country_code + in: query + required: false + schema: + type: + - string + - "null" + description: | + The ISO 3166 country or territory code + from where the shipment is being imported to. If this is omitted then all import fields for all countries will be returned + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: US + - name: export_country_code + in: query + required: false + schema: + type: + - string + - "null" + description: | + The ISO 3166 country or territory code + from where the shipment is being exported from. If this is omitted then all export fields for all countries will be returned + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: IT + - name: locale + in: query + required: false + schema: + type: string + description: "" + minLength: 5 + maxLength: 5 + pattern: ^[a-z]{2}-[A-Z]{2}$ + default: en-US + example: en-US + - name: commodity_codes + in: query + required: false + description: Optional comma-separated list of tariff codes to filter results. + schema: + type: + - string + - "null" + minLength: 1 + maxLength: 2000 + example: "2926400000,3003395000" + operationId: getCountryFieldData + security: + - oauth2: [] + - oauthCie: [] + - JWTAuth: [] + tags: + - Field Data + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: "#/components/schemas/CountryFieldsGetFieldsSuccessResponseV2" + example: + commodityCodes: + - commodityCode: "2926400000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + - commodityCode: "3003395000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + fieldGroups: + - countryCode: US + countryName: UNITED STATES OF AMERICA + shipmentType: Import + groupKey: US-IMP-FDA + details: This is for US import FDA fields + regulation: FDA + regulationSections: + - sectionKey: Cos + sectionName: Cosmetics + - sectionKey: Bio + sectionName: Biologics + - sectionKey: Dev + sectionName: Device + - sectionKey: Foo + sectionName: Food + fields: + - sectionKey: MnuNa + label: Manufacturer Name + order: "1" + tooltip: Type of shipping bill to be processed for the shipment + isRequired: C + requirementConditions: + - fieldKey: MnuPslCd + operator: "!=" + value: "" + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerName + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "8" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + - sectionKey: MnuAdLn1Te + label: Manufacturer Address Line 1 + order: "1" + tooltip: Line 1 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine1 + level: Product + - sectionKey: MnuAdLn2Te + label: Manufacturer Address Line 2 + order: "1" + tooltip: Line 2 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine2 + level: Product + - sectionKey: MnuAdLn3Te + label: Manufacturer Address Line 3 + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuCtyNa + label: Manufacturer City Name + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuStPrvCd + label: Manufacturer State/Province Code + order: "1" + tooltip: The state/province for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerStateProvinceCode + level: Product + - sectionKey: MnuCtyCd + label: Manufacturer Country Code + order: "1" + tooltip: The country code for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerCountryCode + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "1" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + "401": + $ref: '#/components/responses/Unauthorized' + "422": + $ref: '#/components/responses/UnprocessableEntity' + "500": + $ref: '#/components/responses/ServerError' +components: + securitySchemes: + oauth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token + scopes: {} + oauthCie: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token + scopes: {} + JWTAuth: + type: "http" + scheme: bearer + bearerFormat: JWT + parameters: + transId: + name: transId + in: header + required: true + schema: + type: string + description: Transaction Id + transactionSrc: + name: transactionSrc + in: header + required: true + schema: + type: string + description: Identifies the clients/source application that is calling + Content-Type: + name: Content-Type + in: header + required: true + schema: + type: string + description: accepted value application/json + headers: + BkndTransId: + description: The backend transaction id. + schema: + type: string + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]+$ + maxLength: 512 + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]+$ + maxLength: 512 + example: UPS.com + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + schema: + type: string + example: UJ0001 + APIErrorMsg: + description: The API error message. + schema: + type: string + example: Invalid token or token is not present. + responses: + BadRequest: + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + example: + response: + errors: + - code: "105.000" + message: Malformed JSON request + - code: "105.004" + message: Field value is required + description: "VALUE_REQUIRED" + field: "shipperNumber" + value: null + Unauthorized: + description: Unauthorized + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + example: + response: + errors: + - code: "105.401" + message: Invalid token or token is not present + description: null + field: null + value: null + UnprocessableEntity: + description: Unprocessable Entity + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/CountryFieldsErrorResponseV2" + example: + response: + errors: + - code: "105.001" + description: INVALID_FIELD + field: importCountryCode + message: Supplied value was not in the correct range of valid values. + value: USA + ServerError: + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + example: + response: + errors: + - code: "105.500" + message: Internal Server Error + description: INTERNAL_ERROR + field: null + value: null + schemas: + #/content/fields/country-fields + CountryFieldsPostFieldsRequestV2: + type: object + description: Container for the posting of field data + properties: + shipperNumber: + type: string + description: This represents the shipper account number. Required when actionType is save. + minLength: 6 + maxLength: 6 + example: X5R660 + actionType: + type: string + description: Specify the intent of the request. 'Save' will inherently perform validation. + enum: + - validate + - save + trackingNumber: + type: string + description: Tthe lead 1Z number fore the shipment. Required when actionType is save. + minLength: 18 + maxLength: 18 + pattern: ^1Z[0-9A-Z]{16}$ + example: 1Z1234567891234560 + shipmentMetaData: + $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' + products: + type: array + description: Unbounded list of containers for products included on the shipment being updated + minItems: 1 + items: + type: object + properties: + productId: + type: string + description: An identifier for the product + minLength: 1 + maxLength: 50 + example: PROD-001 + productDescription: + type: string + description: The description of the product + minLength: 1 + maxLength: 105 + example: Sample pharma goods + commodityCode: + $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' + productMetaData: + $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' + additionalProperties: false + required: + - productId + - productDescription + - productMetaData + additionalProperties: false + required: + - actionType + CountryFieldsGetFieldsSuccessResponseV2: + type: object + description: Contains commodity code groupings and the detailed field metadata required per country, process, and Regulation. + properties: + commodityCodes: + type: array + description: Unbounded list of commodity codes and their associated compliance Regulations. + items: + type: object + properties: + commodityCode: + $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' + regulations: + type: array + description: Regulations that require additional data for this commodity code. + minItems: 1 + items: + type: object + properties: + regulation: + $ref: '#/components/schemas/CountryFieldsRegulationV2' + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + additionalProperties: false + required: + - regulation + - regulationSections + additionalProperties: false + required: + - commodityCode + - regulations + fieldGroups: + type: array + description: Unbounded list of field group definitions grouped by country, shipment type, and Regulation. + minItems: 1 + items: + type: object + properties: + countryCode: + type: string + description: The ISO 3166 country or territory code the fields pertain to. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: US + countryName: + type: string + description: Country name the fields apply to. + example: UNITED STATES OF AMERICA + shipmentType: + type: string + description: Indicates what direction of movement the fields pertain to. + oneOf: + - title: Fields for import movment + const: Import + - title: Fields for export movement + const: Export + - title: Fields for both movements + const: Both + groupKey: + $ref: '#/components/schemas/CountryFieldsGroupKeyV2' + details: + type: string + description: Provides details on why and when the information is needed. + example: This is for US import FDA fields + regulation: + $ref: '#/components/schemas/CountryFieldsRegulationV2' + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + fields: + type: array + description: Unbounded list of individual field definitions. + minItems: 1 + items: + type: object + properties: + sectionKey: + $ref: '#/components/schemas/CountryFieldsSectionKeyV2' + label: + type: string + description: Human-readable name of the field. + example: Manufacturer Name + order: + type: string + description: Display order for the field. + minLength: 1 + maxLength: 3 + example: "1" + tooltip: + type: + - string + - "null" + description: Tooltip text explaining the field. + example: The name of the manufacturer for the product + isRequired: + type: string + description: Returns the conditionality of the field + oneOf: + - title: "Yes" + const: "Y" + - title: "No" + const: "N" + - title: "Conditional" + description: "If returned there will be at least one requirement condition" + const: "C" + requirementConditions: + type: + - array + - "null" + description: Unbounded array of rules. Conditionally required when is 'isRequired' flag is set. + items: + type: object + description: | + An object containing the specifics of each rule. Order is to be applied + top-down (OR conditions align with the prior rule). + properties: + logicalOperator: + type: string + description: | + Determines how the rules are joined when evaluating the condition if there are multiple rules. + Required for all rules except the first. + enum: + - "AND" + - "OR" + fieldKey: + type: + - string + - "null" + description: The key for the field that this rule is evaluating + example: IN001 + operator: + type: + - string + - "null" + description: The operator used when evaluating the rule + oneOf: + - title: Equals + const: "=" + - title: Greater Than + const: ">" + - title: Less Than + const: "<" + - title: Not Equal To + const: "!=" + value: + type: + - string + - "null" + description: The value used when evaluating the rule + example: CSB V + additionalProperties: false + required: + - fieldKey + - operator + - value + fieldType: + type: string + description: The type of the field, based on available html form inputs + enum: + - textbox + - list + - date + - radio + - checkbox + - textarea + example: textbox + allowedValueCount: + type: integer + description: Number of occurnces allowed for this field + minLength: 1 + maxLength: 2 + default: 1 + example: 1 + validation: + type: object + description: rule validation object + properties: + minLength: + type: + - integer + - "null" + description: The min length allowed for text fields + minLength: 1 + maxLength: 2 + minimum: 1 + maximum: 99 + example: 1 + maxLength: + type: + - integer + - "null" + description: The max length allowed for text fields + minLength: 1 + maxLength: 3 + minimum: 1 + maximum: 100 + example: 10 + errorMessage: + type: + - string + - "null" + description: Error Message + example: Enter a valid alpha numeric value. + dataType: + type: string + description: defines which type of values to look for + oneOf: + - title: Custom + description: user will be required to enter a custom regex pattern + const: Custom + - title: List + description: listValues will need to be populated with a list of possible values for the field + const: List + - title: Email + const: Email + - title: Text + const: Text + - title: Alphanumeric + const: Alphanumeric + - title: Number + const: Number + - title: Date + const: Date + regexPattern: + type: + - string + - "null" + description: | + A regex-based validation pattern for the field which should be applied when validating, + Required when the type is 'custom'. + example: ^[a-zA-Z0-9]+$ + listValues: + type: array + description: Unbounded list of string values to validate against. Required for type 'List' + items: + type: object + description: value to validate against + properties: + displayText: + type: string + description: Value to display in the dropdown for consumers + examples: + - GSTIN (Normal) + - GSTIN (Govt Entities) + - GSTIN (Diplomats) + - PAN Number + - TAN Number + - Passport Number + - Aadhaar Number + - Voter Id + internalValue: + type: string + description: Internal value for each dropdown item that is hidden to consumers + examples: + - GSTIN + - GSTINGE + - GSTIND + - PANNO + - TANNO + - PASSNO + - AADHAARNO + - VID + additionalProperties: false + required: + - displayText + - internalValue + additionalProperties: false + required: + - minLength + - maxLength + - errorMessage + - dataType + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + keyAlias: + type: + - string + - "null" + description: Alias used to identify the field when mapping to downstream systems. + example: ManufacturerName + level: + type: + - string + - "null" + description: Indicates whether the field applies at the shipment or product level. + enum: + - Shipment + - Product + example: Product + additionalProperties: false + required: + - order + - sectionKey + - label + - tooltip + - isRequired + - fieldType + - allowedValueCount + - validation + - regulationSections + additionalProperties: false + additionalProperties: false + required: + - countryCode + - shipmentType + - groupKey + - details + - regulation + - regulationSections + - fields + additionalProperties: false + required: + - commodityCodes + + #COMMON + CountryFieldsCommodityCodeV2: + type: string + description: The tariff code for the product for the selected country and process type + minLength: 1 + maxLength: 15 + example: "300490" + CountryFieldsGroupKeyV2: + type: string + description: Field group key returned by the GET endpoint used to scope the shipment metadata payload. + minLength: 1 + maxLength: 50 + example: US-IMP-CDC + CountryFieldsRequestMetaDataV2: + type: array + description: Unbounded list of containers for product metadata groups + minItems: 1 + items: + type: object + properties: + groupKey: + $ref: '#/components/schemas/CountryFieldsGroupKeyV2' + fields: + type: array + description: Unbounded list of key-value pairs describing product fields + minItems: 1 + items: + type: object + properties: + fieldKey: + type: string + description: Identifier for the field. + minLength: 1 + maxLength: 50 + examples: + - ImportLicenseNumber + - CSBType + - IECCode + - Amount + - CurrencyCode + - MnuNa + - MnuAdLn1Te + - MnuAdLn2Te + - MnuAdLn3Te + - MnuCtyNa + - MnuStPrvCd + - MnuCtyCd + - MnuPslCd + regulationSections: + $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + fieldValue: + type: string + description: Value of the field + minLength: 0 + maxLength: 500 + example: UPS Labs + additionalProperties: false + required: + - fieldKey + - regulationSections + - fieldValue + additionalProperties: false + required: + - fields + CountryFieldsSectionKeyV2: + type: string + description: Identifier for the field. + minLength: 1 + maxLength: 50 + examples: + - Bio + - CSB + - Cos + - Dev + - Foo + CountryFieldsRegulationV2: + type: string + description: Identifier for the compliance Regulation. + minLength: 1 + maxLength: 50 + example: FDA + CountryFieldsRegulationSectionV2: + type: array + description: Unbounded list of regulationSection definitions for this Regulation. + minItems: 1 + items: + type: object + properties: + sectionKey: + description: Identifier for the field. Conditionaly required when sectionName is not present. + $ref: '#/components/schemas/CountryFieldsSectionKeyV2' + sectionName: + type: string + description: Human-readable regulationSection label. Conditionally required when sectionKey is not present. + minLength: 1 + maxLength: 100 + example: Cosmetics + additionalProperties: false + CountryFieldsErrorResponseV2: + type: object + description: Response object for errors + properties: + response: + description: Response container to store errors + type: object + properties: + errors: + type: array + description: Unbounded array containing one or more errors + items: + type: object + description: Error entity + properties: + code: + type: string + description: code for the given message + minLength: 1 + example: "105.002" + message: + type: string + description: the warning or error message to be conveyed + minLength: 1 + example: Supplied Key was not in the correct range. + description: + type: + - string + - "null" + description: Internal description of the error + minLength: 1 + example: INVALID_KEY + field: + type: + - string + - "null" + description: The path to the field causing the error as returned from the backend services. + minLength: 1 + example: shipperNumber + value: + type: + - string + - "null" + description: The value that caused the error + minLength: 1 + example: "789999" + additionalProperties: false + required: + - code + - message + required: + - errors + additionalProperties: false + required: + - response + additionalProperties: false From 3cd29ec2415560334d4bdd618412a9d4bbd7752c Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 21 Jan 2026 15:01:35 -0500 Subject: [PATCH 41/89] Updated --- CustomsDetailV2.yaml | 510 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 509 insertions(+), 1 deletion(-) diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml index b9ed45f..8d89ad0 100644 --- a/CustomsDetailV2.yaml +++ b/CustomsDetailV2.yaml @@ -3,9 +3,10 @@ info: title: Customs Detail version: "1.0" description: > + ## Product Info Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. - ## Key Business Values + ## Key Business Values - Ensures clients always receive the latest compliance requirements. - Allows field collection to be fully managed through configurable user settings. - Flexible framework eliminates additional code changes as compliance fields evolve. @@ -283,6 +284,21 @@ paths: $ref: "#/components/headers/transactionSrc" Content-Type: $ref: "#/components/headers/Content-Type" + + + + + + + + + + + + + + + content: application/json: schema: @@ -518,10 +534,73 @@ paths: keyAlias: ManufacturerPostalCode level: Product "401": + + + $ref: '#/components/responses/Unauthorized' + + + + + + + + + + + + + + + + + + + + + + "422": + + + $ref: '#/components/responses/UnprocessableEntity' + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + "500": + + + $ref: '#/components/responses/ServerError' components: securitySchemes: @@ -540,7 +619,25 @@ components: tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token scopes: {} oauthCie: + + + + + + + + + + + + + + + + type: oauth2 + + description: | Find your Client ID and Secret on your app info page. 1. Select "Try It" @@ -559,6 +656,9 @@ components: bearerFormat: JWT parameters: transId: + + + name: transId in: header required: true @@ -572,6 +672,17 @@ components: schema: type: string description: Identifies the clients/source application that is calling + + + + + + + + + + + Content-Type: name: Content-Type in: header @@ -595,8 +706,20 @@ components: transactionSrc: description: Identifies the client/source application that is calling. schema: + + + + + + + + + + type: string pattern: ^[a-zA-Z0-9-.]+$ + + maxLength: 512 example: UPS.com Content-Type: @@ -645,6 +768,31 @@ components: field: "shipperNumber" value: null Unauthorized: + + + + + + + + + + + + + + + + + + + + + + + + + description: Unauthorized headers: BkndTransId: @@ -700,6 +848,16 @@ components: value: USA ServerError: description: Server Error + + + + + + + + + + headers: BkndTransId: $ref: "#/components/headers/BkndTransId" @@ -728,23 +886,95 @@ components: schemas: #/content/fields/country-fields CountryFieldsPostFieldsRequestV2: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + type: object description: Container for the posting of field data properties: shipperNumber: + + + + + + + + + + + + + + + + + type: string + + description: This represents the shipper account number. Required when actionType is save. minLength: 6 maxLength: 6 example: X5R660 actionType: type: string + + description: Specify the intent of the request. 'Save' will inherently perform validation. enum: - validate - save trackingNumber: type: string + + + + + + + + description: Tthe lead 1Z number fore the shipment. Required when actionType is save. minLength: 18 maxLength: 18 @@ -753,11 +983,18 @@ components: shipmentMetaData: $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' products: + + + type: array description: Unbounded list of containers for products included on the shipment being updated minItems: 1 items: + + + type: object + properties: productId: type: string @@ -955,14 +1192,116 @@ components: minLength: 1 maxLength: 2 default: 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + example: 1 validation: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + type: object description: rule validation object + + properties: minLength: type: - integer + + + + + + + + - "null" description: The min length allowed for text fields minLength: 1 @@ -1052,18 +1391,182 @@ components: additionalProperties: false required: - minLength + + + + + + + + + + + + + + + + + - maxLength - errorMessage - dataType regulationSections: $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' keyAlias: + + + + + + + + + + + + + + + + + + + + + + + + + + + type: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - string - "null" description: Alias used to identify the field when mapping to downstream systems. example: ManufacturerName level: + type: - string - "null" @@ -1071,6 +1574,11 @@ components: enum: - Shipment - Product + + + + + example: Product additionalProperties: false required: From 043c90c04aafee979d871ca9b0733fcec935bcc1 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 21 Jan 2026 15:07:54 -0500 Subject: [PATCH 42/89] Update --- CustomsDetailV2.yaml | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml index 8d89ad0..cee7626 100644 --- a/CustomsDetailV2.yaml +++ b/CustomsDetailV2.yaml @@ -2,15 +2,17 @@ openapi: 3.1.0 info: title: Customs Detail version: "1.0" - description: > - ## Product Info - Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. + + description: | + ## Product Info + Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. ## Key Business Values - - Ensures clients always receive the latest compliance requirements. - - Allows field collection to be fully managed through configurable user settings. - - Flexible framework eliminates additional code changes as compliance fields evolve. - - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. + - Ensures clients always receive the latest compliance requirements. + - Allows field collection to be fully managed through configurable user settings. + - TFlexible framework eliminates additional code changes as compliance fields evolve. + - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. + servers: - url: https://www.livesite.ups.com/trade/compliance/{version} description: URL for JWT based authentication that can be used for any environment (production, staging, product test) via hosts file. From 4b268eba6369b65109cd4c44cc696762e93e834c Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 21 Jan 2026 15:12:54 -0500 Subject: [PATCH 43/89] Update Updated the title and description of the Customs Detail API to include a hyperlink for more information. --- CustomsDetailV2.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml index cee7626..7ca2de2 100644 --- a/CustomsDetailV2.yaml +++ b/CustomsDetailV2.yaml @@ -1,11 +1,11 @@ openapi: 3.1.0 info: - title: Customs Detail + title: Customs Detail API version: "1.0" description: | ## Product Info - Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. + Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. ## Key Business Values - Ensures clients always receive the latest compliance requirements. From 4e382edc4ffa1b7951f0acf20da7fb49bd6e9dd8 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Thu, 22 Jan 2026 08:48:35 -0500 Subject: [PATCH 44/89] Update update --- CustomsDetailV2.yaml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml index 7ca2de2..66a1313 100644 --- a/CustomsDetailV2.yaml +++ b/CustomsDetailV2.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Customs Detail API - version: "1.0" + version: "" description: | ## Product Info @@ -35,9 +35,7 @@ servers: default: v2 enum: - v2 -tags: - - name: Field Data - description: Endpoints related to the required fields + paths: /content/fields/country-fields: post: From 87329ecd25b8f3f4a6f6d9ade1401a538cace9bd Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Thu, 22 Jan 2026 08:52:51 -0500 Subject: [PATCH 45/89] Update --- CustomsDetailV2.yaml | 1130 ++++++++++++------------------------------ 1 file changed, 317 insertions(+), 813 deletions(-) diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml index 66a1313..4039a10 100644 --- a/CustomsDetailV2.yaml +++ b/CustomsDetailV2.yaml @@ -4,14 +4,14 @@ info: version: "" description: | - ## Product Info - Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. + ## Product Info + Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. - ## Key Business Values - - Ensures clients always receive the latest compliance requirements. - - Allows field collection to be fully managed through configurable user settings. - - TFlexible framework eliminates additional code changes as compliance fields evolve. - - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. + ## Key Business Values + - Ensures clients always receive the latest compliance requirements. + - Allows field collection to be fully managed through configurable user settings. + - TFlexible framework eliminates additional code changes as compliance fields evolve. + - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. servers: - url: https://www.livesite.ups.com/trade/compliance/{version} @@ -34,7 +34,7 @@ servers: version: default: v2 enum: - - v2 + - v2 paths: /content/fields/country-fields: @@ -57,8 +57,6 @@ paths: - oauth2: [] - oauthCie: [] - JWTAuth: [] - tags: - - Field Data requestBody: content: application/json: @@ -201,13 +199,13 @@ paths: Content-Type: $ref: "#/components/headers/Content-Type" "400": - $ref: '#/components/responses/BadRequest' + $ref: "#/components/responses/BadRequest" "401": - $ref: '#/components/responses/Unauthorized' + $ref: "#/components/responses/Unauthorized" "422": - $ref: '#/components/responses/UnprocessableEntity' + $ref: "#/components/responses/UnprocessableEntity" "500": - $ref: '#/components/responses/ServerError' + $ref: "#/components/responses/ServerError" get: summary: Returns Required Country Fields description: This returns an array of fields that are required for the provided import and/or export country @@ -219,7 +217,7 @@ paths: in: query required: false schema: - type: + type: - string - "null" description: | @@ -233,7 +231,7 @@ paths: in: query required: false schema: - type: + type: - string - "null" description: | @@ -259,7 +257,7 @@ paths: required: false description: Optional comma-separated list of tariff codes to filter results. schema: - type: + type: - string - "null" minLength: 1 @@ -270,338 +268,260 @@ paths: - oauth2: [] - oauthCie: [] - JWTAuth: [] - tags: - - Field Data responses: - "200": - description: Success - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - - - - - - - - - - - - - - - + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsGetFieldsSuccessResponseV2" - example: - commodityCodes: - - commodityCode: "2926400000" - regulations: - - regulation: FDA - regulationSections: - - sectionKey: DRU - - commodityCode: "3003395000" - regulations: - - regulation: FDA - regulationSections: - - sectionKey: DRU - fieldGroups: - - countryCode: US - countryName: UNITED STATES OF AMERICA - shipmentType: Import - groupKey: US-IMP-FDA - details: This is for US import FDA fields - regulation: FDA - regulationSections: - - sectionKey: Cos - sectionName: Cosmetics - - sectionKey: Bio - sectionName: Biologics - - sectionKey: Dev - sectionName: Device - - sectionKey: Foo - sectionName: Food - fields: - - sectionKey: MnuNa - label: Manufacturer Name - order: "1" - tooltip: Type of shipping bill to be processed for the shipment - isRequired: C - requirementConditions: - - fieldKey: MnuPslCd - operator: "!=" - value: "" - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerName - level: Product - - sectionKey: MnuPslCd - label: Manufacturer Postal Code - order: "8" - tooltip: The postal code address of the manufacturer for the product - isRequired: Y - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerPostalCode - level: Product - - sectionKey: MnuAdLn1Te - label: Manufacturer Address Line 1 - order: "1" - tooltip: Line 1 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine1 - level: Product - - sectionKey: MnuAdLn2Te - label: Manufacturer Address Line 2 - order: "1" - tooltip: Line 2 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine2 - level: Product - - sectionKey: MnuAdLn3Te - label: Manufacturer Address Line 3 - order: "1" - tooltip: Line 3 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine3 - level: Product - - sectionKey: MnuCtyNa - label: Manufacturer City Name - order: "1" - tooltip: Line 3 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine3 - level: Product - - sectionKey: MnuStPrvCd - label: Manufacturer State/Province Code - order: "1" - tooltip: The state/province for the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerStateProvinceCode - level: Product - - sectionKey: MnuCtyCd - label: Manufacturer Country Code - order: "1" - tooltip: The country code for the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerCountryCode - level: Product - - sectionKey: MnuPslCd - label: Manufacturer Postal Code - order: "1" - tooltip: The postal code address of the manufacturer for the product - isRequired: Y - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerPostalCode - level: Product - "401": - - - - $ref: '#/components/responses/Unauthorized' - - - - - - - - - - - - - - - - - - - - - - - "422": - - - - $ref: '#/components/responses/UnprocessableEntity' - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - "500": - - - - $ref: '#/components/responses/ServerError' + application/json: + schema: + $ref: "#/components/schemas/CountryFieldsGetFieldsSuccessResponseV2" + example: + commodityCodes: + - commodityCode: "2926400000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + - commodityCode: "3003395000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + fieldGroups: + - countryCode: US + countryName: UNITED STATES OF AMERICA + shipmentType: Import + groupKey: US-IMP-FDA + details: This is for US import FDA fields + regulation: FDA + regulationSections: + - sectionKey: Cos + sectionName: Cosmetics + - sectionKey: Bio + sectionName: Biologics + - sectionKey: Dev + sectionName: Device + - sectionKey: Foo + sectionName: Food + fields: + - sectionKey: MnuNa + label: Manufacturer Name + order: "1" + tooltip: Type of shipping bill to be processed for the shipment + isRequired: C + requirementConditions: + - fieldKey: MnuPslCd + operator: "!=" + value: "" + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerName + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "8" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + - sectionKey: MnuAdLn1Te + label: Manufacturer Address Line 1 + order: "1" + tooltip: Line 1 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine1 + level: Product + - sectionKey: MnuAdLn2Te + label: Manufacturer Address Line 2 + order: "1" + tooltip: Line 2 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine2 + level: Product + - sectionKey: MnuAdLn3Te + label: Manufacturer Address Line 3 + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuCtyNa + label: Manufacturer City Name + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuStPrvCd + label: Manufacturer State/Province Code + order: "1" + tooltip: The state/province for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerStateProvinceCode + level: Product + - sectionKey: MnuCtyCd + label: Manufacturer Country Code + order: "1" + tooltip: The country code for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerCountryCode + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "1" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + "401": + $ref: "#/components/responses/Unauthorized" + + "422": + $ref: "#/components/responses/UnprocessableEntity" + + "500": + $ref: "#/components/responses/ServerError" components: securitySchemes: oauth2: @@ -619,25 +539,8 @@ components: tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token scopes: {} oauthCie: - - - - - - - - - - - - - - - - type: oauth2 - - + description: | Find your Client ID and Secret on your app info page. 1. Select "Try It" @@ -656,9 +559,6 @@ components: bearerFormat: JWT parameters: transId: - - - name: transId in: header required: true @@ -672,17 +572,7 @@ components: schema: type: string description: Identifies the clients/source application that is calling - - - - - - - - - - - + Content-Type: name: Content-Type in: header @@ -699,27 +589,16 @@ components: transId: description: An identifier unique to the request. schema: - type: string + type: string pattern: ^[a-zA-Z0-9-.]+$ maxLength: 512 example: 0a1b9c2d8e3f7g4h6i5 transactionSrc: description: Identifies the client/source application that is calling. schema: - - - - - - - - - - type: string pattern: ^[a-zA-Z0-9-.]+$ - - + maxLength: 512 example: UPS.com Content-Type: @@ -756,7 +635,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + $ref: "#/components/schemas/CountryFieldsErrorResponseV2" example: response: errors: @@ -768,31 +647,6 @@ components: field: "shipperNumber" value: null Unauthorized: - - - - - - - - - - - - - - - - - - - - - - - - - description: Unauthorized headers: BkndTransId: @@ -810,15 +664,15 @@ components: content: application/json: schema: - $ref: '#/components/schemas/CountryFieldsErrorResponseV2' - example: + $ref: "#/components/schemas/CountryFieldsErrorResponseV2" + example: response: - errors: + errors: - code: "105.401" message: Invalid token or token is not present description: null field: null - value: null + value: null UnprocessableEntity: description: Unprocessable Entity headers: @@ -835,8 +689,8 @@ components: APIErrorMessage: $ref: "#/components/headers/APIErrorMsg" content: - application/json: - schema: + application/json: + schema: $ref: "#/components/schemas/CountryFieldsErrorResponseV2" example: response: @@ -848,16 +702,7 @@ components: value: USA ServerError: description: Server Error - - - - - - - - - - + headers: BkndTransId: $ref: "#/components/headers/BkndTransId" @@ -874,9 +719,9 @@ components: content: application/json: schema: - $ref: '#/components/schemas/CountryFieldsErrorResponseV2' + $ref: "#/components/schemas/CountryFieldsErrorResponseV2" example: - response: + response: errors: - code: "105.500" message: Internal Server Error @@ -886,115 +731,40 @@ components: schemas: #/content/fields/country-fields CountryFieldsPostFieldsRequestV2: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - type: object description: Container for the posting of field data properties: shipperNumber: - - - - - - - - - - - - - - - - - type: string - - + description: This represents the shipper account number. Required when actionType is save. minLength: 6 maxLength: 6 example: X5R660 actionType: type: string - - + description: Specify the intent of the request. 'Save' will inherently perform validation. enum: - validate - save trackingNumber: type: string - - - - - - - - + description: Tthe lead 1Z number fore the shipment. Required when actionType is save. minLength: 18 maxLength: 18 pattern: ^1Z[0-9A-Z]{16}$ example: 1Z1234567891234560 shipmentMetaData: - $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' + $ref: "#/components/schemas/CountryFieldsRequestMetaDataV2" products: - - - type: array description: Unbounded list of containers for products included on the shipment being updated minItems: 1 items: - - - type: object - + properties: productId: type: string @@ -1009,9 +779,9 @@ components: maxLength: 105 example: Sample pharma goods commodityCode: - $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' + $ref: "#/components/schemas/CountryFieldsCommodityCodeV2" productMetaData: - $ref: '#/components/schemas/CountryFieldsRequestMetaDataV2' + $ref: "#/components/schemas/CountryFieldsRequestMetaDataV2" additionalProperties: false required: - productId @@ -1031,7 +801,7 @@ components: type: object properties: commodityCode: - $ref: '#/components/schemas/CountryFieldsCommodityCodeV2' + $ref: "#/components/schemas/CountryFieldsCommodityCodeV2" regulations: type: array description: Regulations that require additional data for this commodity code. @@ -1040,9 +810,9 @@ components: type: object properties: regulation: - $ref: '#/components/schemas/CountryFieldsRegulationV2' + $ref: "#/components/schemas/CountryFieldsRegulationV2" regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" additionalProperties: false required: - regulation @@ -1080,15 +850,15 @@ components: - title: Fields for both movements const: Both groupKey: - $ref: '#/components/schemas/CountryFieldsGroupKeyV2' + $ref: "#/components/schemas/CountryFieldsGroupKeyV2" details: type: string description: Provides details on why and when the information is needed. example: This is for US import FDA fields regulation: - $ref: '#/components/schemas/CountryFieldsRegulationV2' + $ref: "#/components/schemas/CountryFieldsRegulationV2" regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" fields: type: array description: Unbounded list of individual field definitions. @@ -1097,7 +867,7 @@ components: type: object properties: sectionKey: - $ref: '#/components/schemas/CountryFieldsSectionKeyV2' + $ref: "#/components/schemas/CountryFieldsSectionKeyV2" label: type: string description: Human-readable name of the field. @@ -1126,7 +896,7 @@ components: description: "If returned there will be at least one requirement condition" const: "C" requirementConditions: - type: + type: - array - "null" description: Unbounded array of rules. Conditionally required when is 'isRequired' flag is set. @@ -1174,7 +944,7 @@ components: required: - fieldKey - operator - - value + - value fieldType: type: string description: The type of the field, based on available html form inputs @@ -1192,116 +962,17 @@ components: minLength: 1 maxLength: 2 default: 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + example: 1 validation: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - type: object description: rule validation object - - + properties: minLength: type: - integer - - - - - - - - + - "null" description: The min length allowed for text fields minLength: 1 @@ -1391,182 +1062,19 @@ components: additionalProperties: false required: - minLength - - - - - - - - - - - - - - - - - + - maxLength - errorMessage - dataType regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" keyAlias: - - - - - - - - - - - - - - - - - - - - - - - - - - - type: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - string - "null" description: Alias used to identify the field when mapping to downstream systems. example: ManufacturerName level: - type: - string - "null" @@ -1574,11 +1082,7 @@ components: enum: - Shipment - Product - - - - - + example: Product additionalProperties: false required: @@ -1626,7 +1130,7 @@ components: type: object properties: groupKey: - $ref: '#/components/schemas/CountryFieldsGroupKeyV2' + $ref: "#/components/schemas/CountryFieldsGroupKeyV2" fields: type: array description: Unbounded list of key-value pairs describing product fields @@ -1654,7 +1158,7 @@ components: - MnuCtyCd - MnuPslCd regulationSections: - $ref: '#/components/schemas/CountryFieldsRegulationSectionV2' + $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" fieldValue: type: string description: Value of the field @@ -1695,7 +1199,7 @@ components: properties: sectionKey: description: Identifier for the field. Conditionaly required when sectionName is not present. - $ref: '#/components/schemas/CountryFieldsSectionKeyV2' + $ref: "#/components/schemas/CountryFieldsSectionKeyV2" sectionName: type: string description: Human-readable regulationSection label. Conditionally required when sectionKey is not present. @@ -1710,14 +1214,14 @@ components: response: description: Response container to store errors type: object - properties: + properties: errors: type: array description: Unbounded array containing one or more errors - items: + items: type: object description: Error entity - properties: + properties: code: type: string description: code for the given message @@ -1729,7 +1233,7 @@ components: minLength: 1 example: Supplied Key was not in the correct range. description: - type: + type: - string - "null" description: Internal description of the error @@ -1743,19 +1247,19 @@ components: minLength: 1 example: shipperNumber value: - type: + type: - string - "null" description: The value that caused the error minLength: 1 example: "789999" additionalProperties: false - required: - - code - - message - required: - - errors + required: + - code + - message + required: + - errors additionalProperties: false - required: + required: - response additionalProperties: false From 9ae0ff6fd00206d0c8d595fc160b7e32be377c78 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Thu, 22 Jan 2026 08:56:10 -0500 Subject: [PATCH 46/89] Update --- CustomsDetailV2.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml index 4039a10..80536f6 100644 --- a/CustomsDetailV2.yaml +++ b/CustomsDetailV2.yaml @@ -10,7 +10,7 @@ info: ## Key Business Values - Ensures clients always receive the latest compliance requirements. - Allows field collection to be fully managed through configurable user settings. - - TFlexible framework eliminates additional code changes as compliance fields evolve. + - Flexible framework eliminates additional code changes as compliance fields evolve. - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. servers: From a6758f65dc11a0efca2ad69d6b760ffcd3d08cb7 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Thu, 22 Jan 2026 16:52:00 -0500 Subject: [PATCH 47/89] Update --- Rating.yaml | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/Rating.yaml b/Rating.yaml index 24c4925..f26f721 100644 --- a/Rating.yaml +++ b/Rating.yaml @@ -843,7 +843,6 @@ paths: Pickup: Date: '20250624' Time: '1616' - ShipmentDate: '20250624' responses: '200': description: successful operation @@ -1720,7 +1719,6 @@ paths: "Time": "161682" } }, - "ShipmentDate": "20250624" } } } @@ -1908,10 +1906,6 @@ components: only for HazMat request and with subversion greater than or equal to 1701. maximum: 1 type: string - ShipmentDate: - description: Shipment date. If a ShipmentDate is not provided, it will be defaulted to the current system date.Valid value "yyyyMMdd". - maximum: 1 - type: string Shipper: "$ref": "#/components/schemas/Shipment_Shipper" ShipTo: @@ -3379,6 +3373,8 @@ components: "$ref": "#/components/schemas/Insurance_ExtendedFlexibleParcelIndicator" TimeInTransitFlexibleParcelIndicator: "$ref": "#/components/schemas/Insurance_TimeInTransitFlexibleParcelIndicator" + ParcelProtection: + "$ref": "#/components/schemas/Insurance_ParcelProtection" description: Insurance Accesorial. Only one type of insurance can exist at a time on the shipment. Valid for UPS World Wide Express Freight shipments. Insurance_BasicFlexibleParcelIndicator: type: object @@ -3458,6 +3454,27 @@ components: name: TimeInTransitFlexibleParcelIndicator description: Container to hold Time In Transit Flexible Parcel Indicator information. Valid for UPS World Wide Express Freight shipments. + Insurance_ParcelProtection: + type: object + maximum: 1 + required: + - CurrencyCode + - MonetaryValue + properties: + CurrencyCode: + description: Required if a value for the package declared value amount exists in the MonetaryValue tag. + Must match one of the IATA currency codes. Length is not validated. UPS does not support all international currency codes. + Refer to Currency Codes in the Appendix for a list of valid codes. + maximum: 1 + type: string + minLength: 3 + maxLength: 3 + MonetaryValue: + description: Max value of 5,000 USD for Local and 50,000 USD for Remote. Absolute maximum value is 21474836.47 + maximum: 1 + type: string + minLength: 8 + maxLength: 8 PackageServiceOptions_HazMat: type: object maximum: 1 From addd0a4f88ade48ba89962207118e84d88d9ea02 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 27 Jan 2026 09:27:43 -0500 Subject: [PATCH 48/89] Update --- Rating.yaml | 31 +------------------------------ 1 file changed, 1 insertion(+), 30 deletions(-) diff --git a/Rating.yaml b/Rating.yaml index f26f721..c7b8642 100644 --- a/Rating.yaml +++ b/Rating.yaml @@ -3373,8 +3373,6 @@ components: "$ref": "#/components/schemas/Insurance_ExtendedFlexibleParcelIndicator" TimeInTransitFlexibleParcelIndicator: "$ref": "#/components/schemas/Insurance_TimeInTransitFlexibleParcelIndicator" - ParcelProtection: - "$ref": "#/components/schemas/Insurance_ParcelProtection" description: Insurance Accesorial. Only one type of insurance can exist at a time on the shipment. Valid for UPS World Wide Express Freight shipments. Insurance_BasicFlexibleParcelIndicator: type: object @@ -3453,28 +3451,7 @@ components: xml: name: TimeInTransitFlexibleParcelIndicator description: Container to hold Time In Transit Flexible Parcel Indicator information. Valid - for UPS World Wide Express Freight shipments. - Insurance_ParcelProtection: - type: object - maximum: 1 - required: - - CurrencyCode - - MonetaryValue - properties: - CurrencyCode: - description: Required if a value for the package declared value amount exists in the MonetaryValue tag. - Must match one of the IATA currency codes. Length is not validated. UPS does not support all international currency codes. - Refer to Currency Codes in the Appendix for a list of valid codes. - maximum: 1 - type: string - minLength: 3 - maxLength: 3 - MonetaryValue: - description: Max value of 5,000 USD for Local and 50,000 USD for Remote. Absolute maximum value is 21474836.47 - maximum: 1 - type: string - minLength: 8 - maxLength: 8 + for UPS World Wide Express Freight shipments. PackageServiceOptions_HazMat: type: object maximum: 1 @@ -4688,12 +4665,6 @@ components: "$ref": "#/components/schemas/RatedShipment_TimeInTransit" GuaranteedDelivery: "$ref": "#/components/schemas/RatedShipment_GuaranteedDelivery" - ScheduledDeliveryDate: - description: The rated shipments scheduled delivery date, ScheduledDeliveryDate - returned only when Subversion of 2205 was sent in the request and the - customer has the specific contract. - maximum: 1 - type: string RoarRatedIndicator: description: Informational only maximum: 1 From 438607e2e97107957cf2dfc1674c7ea1d0fbd6f8 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 30 Jan 2026 11:43:21 -0500 Subject: [PATCH 49/89] Update --- Forwarding.yaml | 9071 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 6425 insertions(+), 2646 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index 6116017..35a0f8f 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -36,13 +36,15 @@ servers: - v1 tags: - name: Orders - description: Endpoints related to shipments not yet submitted for processing + description: Create, search, update, and cancel orders before processing. - name: Shipments - description: Endpoints related to shipments in process + description: Rate, create, submit, and manage freight shipments. - name: Info - description: Endpoints related to Information + description: Retrieve reference data such as cities, currencies, and service types. - name: Documents - description: Endpoints related to document generation + description: Generate and reprint shipping labels and manifests. + - name: Quotes + description: Generate and retrieve freight rate quotes. @@ -51,7 +53,7 @@ security: paths: /shipments/rates: post: - summary: Get Freight Rates + summary: Rate Shipment description: Generate estimated freight charges based on the provided origin, destination, payor information, and cargo details. operationId: freightRating tags: @@ -105,8 +107,8 @@ paths: company: Third Party Logistics account: "123456789" address1: 7890 LOGISTICS RD - address2: "" - address3: "" + + city: ATLANTA state: GA postalCode: "30303" @@ -130,7 +132,7 @@ paths: weight: 54 freightType: PALLET isMetric: false - description: Shipment of electronics + orderDescription: Shipment of electronics shipperReference: SHIP123 consigneeReference: CON123 currencyCode: USD @@ -160,12 +162,28 @@ paths: - key: serialNumber value: SN654321 details: - - key: HAZMAT + - key: IsHazmat value: "true" - - key: DV + - key: IsHazmatPassengerAircraft + value: "true" + - key: IsHAPU + value: "true" + - key: DeclaredValue value: "1000" - - key: DV-Currency + - key: DeclaredValueCurrencyCode value: USD + - key: CustomsValue + value: "1000" + - key: CustomsValueCurrencyCode + value: USD + - key: IsSaturdayPickup + value: "false" + - key: IsCustomsClearance + value: "false" + - key: IsFreeDomicileDDU + value: "false" + - key: IsFreeDomicileDDP + value: "false" language: en-US transactionId: TXT123432 responses: @@ -193,8 +211,8 @@ paths: rates: - serviceType: AM guaranteedDelivery: true - deliveryTime: "2025-05-14 12:00:00" - holdAtAirportTime: "2025-05-14 17:00:00" + deliveryTime: "2025-05-14 12:00:00Z" + holdAtAirportTime: "2025-05-14 17:00:00Z" totalCharge: amount: "1170.71" currencyCode: USD @@ -228,7 +246,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -256,7 +274,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -284,7 +302,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -300,7 +318,7 @@ paths: message: Internal Server Error /orders: post: - summary: Create a Order + summary: Create Order operationId: orderCreate description: Create a pending order which becomes a shipment when processed at end-of-day parameters: @@ -320,40 +338,40 @@ paths: $ref: "#/components/schemas/ApolloOrderRequestV1" example: shipper: - account: "123456789" - serviceCenterCode: SDF - contactName: Zeus - contactPhone: "8888888888" - contactEmail: test1@ups.com - details: - - key: ConsolidationId - value: ConsolidationTest - - key: Landmark - value: Behind Twin Tower - - key: AlternateNumber - value: "9876665341" - company: GEMINI SYSTEM INFORMATION - address1: 12380 MORRIS RD - city: Louisville - state: KY - postalCode: "40214" + account: "000990879" + serviceCenterCode: PDX + contactName: Subaru + contactPhone: "541813846" + contactEmail: subaru@ups.com + + + + + + + + company: SUBARU OF AMERICA + address1: 1410 N LOMBARD ST + city: PORTLAND + state: OR + postalCode: "97203" countryCode: US consignee: - account: "123456789" - serviceCenterCode: BOS - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - contactName: Sheldon - contactPhone: "8888888778" - contactEmail: test2@ups.com + account: + serviceCenterCode: MAA + + contactName: Harry + contactPhone: "8885888778" + contactEmail: HarryTest@ups.com details: - - key: AlternateNumber - value: "9877775341" - company: DHL INTERNATIONAL (UK) LTD. - address1: 99 Hereford Street - city: Cranston - state: RI - postalCode: "02920" - countryCode: US + - key: ConsolidationId + value: "ConsolidationTest" + company: Sunrise Logistics Ltd + address1: 45 Greenway Drive + city: Chennai + state: TN + postalCode: "600119" + countryCode: IN thirdParty: account: 3206YY serviceCenterCode: BOS @@ -376,9 +394,9 @@ paths: countryCode: US shipment: shipmentNumber: "9100010271" - serviceType: AM + serviceType: CA paymentType: PPD - pickupDate: 2025-07-24 + pickupDate: 2026-01-09 readyTime: 20:00:00 closeTime: 22:00:00 dropoffTime: 21:00:00 @@ -396,6 +414,11 @@ paths: width: 18 height: 10 weight: 26 + details: + - key: CostPerUnit + value: "3000" + - key: SerialNumber + value: "1232212" - itemDescription: Green floral midi female dress. count: 1 length: 10 @@ -406,38 +429,50 @@ paths: - US - MX - CA - - GBR + - GB details: - - key: HAZMAT + - key: IsHazMat value: "false" - - key: HAPU + - key: IsHAPU value: "true" - - key: SAT + - key: IsSaturdayPickup value: "false" - - key: CC + - key: IsCustomsClearance value: "false" - - key: CV - value: "0" - - key: CV-Currency + - key: CustomsValue + value: "10" + - key: CustomsValueCurrencyCode value: "USD" - - key: DV + - key: DeclaredValue value: "1000" - - key: DV-Currency + - key: DeclaredValueCurrencyCode value: "USD" - key: PICKUP value: "true" - - key: DDU + - key: IsFreeDomicileDDU value: "false" - - key: DDP + - key: IsFreeDomicileDDP value: "false" - key: RESPU value: "true" - - key: RESDLV + - key: IsLiftgatePickup value: "true" - - key: LIFTGTPU + - key: IsLiftgateDelivery value: "true" - - key: LIFTGTDLV + - key: IsHazMatPassengerAircraft value: "true" + - key: "HAZMAT-Instruction" + value: "Lithium Battery" + - key: "ContactName" + value: "Mike" + - key: "ContactPhone" + value: "000-123-4567" + - key: "IsDoorDelivery" + value: "false" + - key: "GovernmentBoLNumber" + value: "BoL-00786" + - key: "RemarksToConsignee" + value: "Handle with care" label: layout: AF-GEMINI format: PDF @@ -530,36 +565,48 @@ paths: - CA - GB details: - - key: HAZMAT + - key: IsHazMat value: "false" - - key: HAPU + - key: IsHAPU value: "true" - - key: SAT + - key: IsSaturdayPickup value: "false" - - key: CC + - key: IsCustomsClearance value: "false" - - key: CV + - key: CustomsValue value: "0" - - key: CV-Currency + - key: CustomsValueCurrencyCode value: "USD" - - key: DV + - key: DeclaredValue value: "1000" - - key: DV-Currency + - key: DeclaredValueCurrencyCode value: "USD" - key: PICKUP value: "true" - - key: DDU + - key: IsFreeDomicileDDU value: "false" - - key: DDP + - key: IsFreeDomicileDDP value: "false" - key: RESPU value: "true" - - key: RESDLV + - key: IsLiftgatePickup value: "true" - - key: LIFTGTPU + - key: IsLiftgateDelivery value: "true" - - key: LIFTGTDLV + - key: IsHazMatPassengerAircraft value: "true" + - key: "HAZMAT-Instruction" + value: "Lithium Battery" + - key: "ContactName" + value: "Mike" + - key: "ContactPhone" + value: "000-123-4567" + - key: "IsDoorDelivery" + value: "false" + - key: "GovernmentBoLNumber" + value: "BoL-00786" + - key: "RemarksToConsignee" + value: "Handle with care" rates: amount: 1526.74 currencyCode: USD @@ -571,6 +618,7 @@ paths: warnings: - code: "1050" message: Consignee Contact Name too long + message: Order created successfully. "400": description: Bad Request @@ -586,7 +634,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -598,7 +646,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -614,7 +662,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -626,7 +674,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "500": description: Server Error @@ -642,7 +690,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -654,14 +702,14 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error delete: - summary: Cancel an Order + summary: Cancel Order operationId: orderCancel tags: - Forwarding - description: Cancel an pending order + description: Cancel a pending order parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -703,6 +751,7 @@ paths: response: shipmentNumber: "9100010271" orderNumber: "9100010270001" + message: Order cancelled successfully. "400": description: Bad Request headers: @@ -717,7 +766,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -729,7 +778,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -745,7 +794,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -773,7 +822,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -785,7 +834,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Order Not Found "500": description: Server Error @@ -801,7 +850,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -813,10 +862,10 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error patch: - summary: Set Date for Orders + summary: Set Order Date operationId: orderSetDate tags: - Forwarding @@ -845,7 +894,7 @@ paths: example: "3912088430001" - name: old_date in: query - description: The current date of the shipment(s). Required for moving all open shipments to a new date. + description: The current date of the shipment(s). Defaults to today if not provided. Required for moving all open shipments to a new date. required: false schema: $ref: "#/components/schemas/ApolloDateV1" @@ -858,7 +907,7 @@ paths: example: "en-US" requestBody: required: true - description: Container for the order details to be moved to another day. + description: Container for the order details to be moved to another day. if newDate value is not provided, it Defaults to today + 1. content: application/json: schema: @@ -892,6 +941,7 @@ paths: shipmentNumber: "910001027" orderNumber: "9100010270001" newDate: 2025-10-22 + message: Pickup date set successfully. "400": description: Bad Request headers: @@ -906,7 +956,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -918,7 +968,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -934,7 +984,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -946,7 +996,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "404": description: Resource Not Found @@ -962,7 +1012,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -974,7 +1024,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "500": description: Server Error @@ -990,7 +1040,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1002,10 +1052,10 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error get: - summary: Order Search + summary: Get Order Details operationId: orderSearch tags: - Forwarding @@ -1016,24 +1066,24 @@ paths: - $ref: "#/components/parameters/Content-Type" - $ref: "#/components/parameters/X-BusinessGUID" - $ref: "#/components/parameters/X-ClientId" - requestBody: - required: true - description: Container for filters to be applied to the search. - content: - application/json: - schema: - $ref: "#/components/schemas/ApolloOrderSearchRequestV1" - example: - shipperAccountNumber: "123456789" - criteriaList: - - criteriaField: ORDER_STATUS - criteriaOperator: NOTEQ - criteriaValue: "8" - - criteriaField: SHIP_DATE - criteriaOperator: BTWN - criteriaValue: 2025-07-23 - criteriaValue2: 2025-07-24 - language: en-US + - name: criteria + in: query + description: The criteria used to search for Orders + required: true + schema: + + $ref: "#/components/schemas/ApolloOrderSearchRequestV1" + + + + + + + + + + + responses: "200": description: OK @@ -1062,7 +1112,7 @@ paths: consignee: account: "123456789" serviceCenterCode: BOS - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + contactName: Sheldon contactPhone: "8888888778" contactEmail: test2@ups.com @@ -1095,6 +1145,7 @@ paths: width: 10 height: 10 weight: 10 + message: Order search completed successfully. "400": description: Bad Request headers: @@ -1109,7 +1160,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1121,7 +1172,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -1137,7 +1188,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1149,7 +1200,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "404": description: Resource Not Found @@ -1165,7 +1216,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1177,7 +1228,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "500": description: Server Error @@ -1193,7 +1244,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1205,11 +1256,11 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error /documents/labels: post: - summary: Re-Print Label + summary: Create Label operationId: printLabel tags: - Forwarding @@ -1234,7 +1285,7 @@ paths: layout: AF-GEMINI responses: "200": - description: OK + description: Response from the Print Label API headers: BkndTransId: $ref: "#/components/headers/BkndTransId" @@ -1252,7 +1303,7 @@ paths: application/json: schema: type: object - description: Response from the Print LAbel API + description: Response from the Print Label API required: - response properties: @@ -1321,36 +1372,48 @@ paths: - CA - GB details: - - key: HAZMAT + - key: IsHazMat value: "false" - - key: HAPU + - key: IsHAPU value: "true" - - key: SAT + - key: IsSaturdayPickup value: "false" - - key: CC + - key: IsCustomsClearance value: "false" - - key: CV + - key: CustomsValue value: "0" - - key: CV-Currency + - key: CustomsValueCurrencyCode value: "USD" - - key: DV + - key: DeclaredValue value: "1000" - - key: DV-Currency + - key: DeclaredValueCurrencyCode value: "USD" - key: PICKUP value: "true" - - key: DDU + - key: IsFreeDomicileDDU value: "false" - - key: DDP + - key: IsFreeDomicileDDP value: "false" - key: RESPU value: "true" - - key: RESDLV + - key: IsLiftgatePickup value: "true" - - key: LIFTGTPU + - key: IsLiftgateDelivery value: "true" - - key: LIFTGTDLV + - key: IsHazMatPassengerAircraft value: "true" + - key: "HAZMAT-Instruction" + value: "Lithium Battery" + - key: "ContactName" + value: "Mike" + - key: "ContactPhone" + value: "000-123-4567" + - key: "IsDoorDelivery" + value: "false" + - key: "GovernmentBoLNumber" + value: "BoL-00786" + - key: "RemarksToConsignee" + value: "Handle with care" rates: amount: 1526.74 currencyCode: USD @@ -1359,6 +1422,7 @@ paths: count: 2 labelService: ND serviceDesc: UPS Next Day Air Freight - NGS + message: Label generated successfully. "400": description: Bad Request headers: @@ -1373,7 +1437,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1385,7 +1449,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -1401,7 +1465,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1429,7 +1493,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1441,7 +1505,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "500": description: Server Error @@ -1457,7 +1521,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1469,12 +1533,12 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error /shipments: patch: - summary: Processes All Shipments + summary: Submit Order Shipments operationId: submitAirShipment tags: - Forwarding @@ -1506,6 +1570,7 @@ paths: schema: type: boolean example: true + default: true - name: manifest_format in: query description: The format of the manifest to be generated. @@ -1513,6 +1578,7 @@ paths: schema: type: string example: "PDF" + default: "PDF" enum: - "DATA" - "PDF" @@ -1596,6 +1662,7 @@ paths: shipmentCount: 1 itemCount: 1 totalWeight: 20 + pieceCount: 2 - serviceCode: D2 serviceName: UPS 2nd Day Air® Freight NGS freightChargesAmount: 24.45 @@ -1605,6 +1672,7 @@ paths: shipmentCount: 1 itemCount: 1 totalWeight: 20 + pieceCount: 2 serviceTotal: freightChargesAmount: 24.45 surchargesAmount: 45.87 @@ -1613,14 +1681,18 @@ paths: shipmentCount: 1 itemCount: 1 totalWeight: 20 + pieceCount: 4 dailyPickupTotals: shipmentCount: 1 itemCount: 1 totalWeight: 20 + pieceCount: 4 currentPickupTotals: shipmentCount: 1 itemCount: 1 totalWeight: 20 + pieceCount: 4 + message: Shipments submitted successfully. "400": description: Bad Request headers: @@ -1635,7 +1707,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1647,7 +1719,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -1663,7 +1735,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1675,7 +1747,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "500": description: Server Error @@ -1691,7 +1763,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1703,10 +1775,10 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error delete: - summary: Cancels a Shipment + summary: Cancel Shipment operationId: cancelAirShipment tags: - Forwarding @@ -1751,6 +1823,7 @@ paths: response: shipperAccountNumber: "123456789" shipmentNumber: "9100010271" + message: Shipment cancelled successfully. "400": description: Bad Request headers: @@ -1765,7 +1838,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1777,7 +1850,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -1793,7 +1866,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1805,7 +1878,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "404": description: Resource Not Found @@ -1821,7 +1894,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1833,7 +1906,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: The requested resource was not found. "500": description: Server Error @@ -1849,7 +1922,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -1861,10 +1934,10 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error post: - summary: Freight Shipment + summary: Ship description: Generate estimated freight rates based on the provided shipment and party details, and create the shipment. operationId: freightShip tags: @@ -1885,8 +1958,8 @@ paths: shipper: account: "123456789" address1: "123 Main St" - address2: "" - address3: "" + + city: "New York" state: "NY" postalCode: "10001" @@ -1898,15 +1971,16 @@ paths: contactPhone: "+1-555-1234" contactEmail: "john.doe@shipper.com" partySectionDetails: - "part": "p434567" + - key: part + value: p434567 details: - key: serialNumber value: SN654321 consignee: - account: "" + account: "999999999" address1: "456 Market St" - address2: "" - address3: "" + + city: "San Francisco" state: "CA" postalCode: "94105" @@ -1918,7 +1992,8 @@ paths: contactPhone: "+1-555-5678" contactEmail: "jane.smith@consignee.com" partySectionDetails: - department: "Receiving" + - key: department + value: Receiving details: - key: serialNumber value: SN654321 @@ -1926,8 +2001,8 @@ paths: company: Third Party Logistics account: "123456789" address1: 7890 LOGISTICS RD - address2: "" - address3: "" + + city: ATLANTA state: GA postalCode: "30303" @@ -1937,8 +2012,9 @@ paths: contactName: John contactPhone: "777777777" contactEmail: john@example.com - partySectionDetails: - "part": "p434567" + partySectionDetails: + - key: part + value: p434567 details: - key: serialNumber value: SN654321 @@ -1946,13 +2022,13 @@ paths: serviceType: "AM" paymentType: "PPD" pickupDate: "2025-08-11" - readyTime: "09:00" - closeTime: "17:00" - dropoffTime: 16:00 + readyTime: "09:00:00" + closeTime: "17:00:00" + dropoffTime: "16:00:00" weight: 25.5 freightType: "PALLET" isMetric: true - description: "Electronics shipment" + orderDescription: "Electronics shipment" shipperReference: "REF123" consigneeReference: "CREF456" currency: "USD" @@ -1979,14 +2055,42 @@ paths: - key: serialNumber value: SN654321 details: - - key: IsHAZMAT - value: "true" - - key: IsHazmatPassengerAircraft - value: "true" + + + + - key: DV value: "1000" - key: DV-Currency - value: "USD" + value: USD + - key: HAZMAT + value: "true" + - key: CV + value: "1000" + - key: CV-Currency + value: USD + - key: CC + value: "true" + - key: DLV + value: "true" + - key: DDU + value: "true" + - key: DDP + value: "true" + - key: RESPU + value: "true" + - key: RESDLV + value: "true" + - key: LIFTGTPU + value: "true" + - key: PICKUP + value: "true" + - key: IsHazmat + value: "true" + - key: IsHazmatPassengerAircraft + value: "true" + - key: HAPU + value: "true" label: layout: "AF-GEMINI" format: "PDF" @@ -1995,6 +2099,17 @@ paths: Model_Number: "X" Model_Year: "2023" Shipper_ReferenceNo: "SHP2401-A3MC220" + FCSD_Part: "123456" + FCSD_PartNumber": "PN-98765" + FCSD_PartDescription": "Widget Assembly" + FCSD_Dealer: "ABC Motors" + NAGS_Part: "1234566" + NAGS_PartNumber: "NAGS-12345" + NAGS_PartDescription: "Glass Panel" + NAGS_Dealer: "XYZ Glassworks" + Y-Release: "Yes" + PO: "PO-12345" + DOR: "DOR-67890" language: "en-us" transactionId: "txn-0016ty675r5" responses: @@ -2051,7 +2166,7 @@ paths: label: format: "PDF" layout: "AF-GEMINI" - labelT: "Base64EncodedLabelString" + image: "Base64EncodedPDF" "400": description: Bad Request @@ -2067,7 +2182,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2095,7 +2210,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2123,7 +2238,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2137,54 +2252,56 @@ paths: errors: - code: "-1003" message: Internal Server Error - - /documents/manifest: - post: - summary: Print Air Manifest - operationId: printAirManifest + get: + summary: Get Shipment Details + description: Retrieves shipment details for air or ocean quotes based on the specified request parameters. + operationId: getShipmentDetails + tags: - Forwarding - description: Generates and returns the manifest for the specified manifest number in the requested format. + parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" - $ref: "#/components/parameters/Content-Type" - $ref: "#/components/parameters/X-BusinessGUID" - $ref: "#/components/parameters/X-ClientId" - - name: account_number - in: query - description: Shipper's UPS Freight Account Number - required: true - schema: - type: string - example: "123456789" - - name: manifest_number + - name: request_type in: query - description: Manifest Number + required: true schema: type: string - example: M810000079 - maxLength: 10 - - name: manifest_format + description: Indicates whether the request is for "Air" or "Ocean". + enum: [Air, Ocean] + example: Ocean + description: The type of shipment ("Air" or "Ocean"). + + + + + + - name: shipment_id in: query - description: Manifest Format + required: true schema: type: string - enum: - - DATA - - PDF - - name: language - in: query - description: Language - required: false - schema: - type: string - example: en-US + + + + + + + + + + description: Unique identifier for the shipment. + example: "200025511" + description: The unique identifier for the shipment. responses: "200": - description: OK + description: Successful headers: BkndTransId: $ref: "#/components/headers/BkndTransId" @@ -2201,84 +2318,145 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ApolloAirShipmentDataResponseV1" + $ref: "#/components/schemas/ApolloShipmentDetailResponseV1" example: response: - account: "123456789" - pickupDate: 2025-07-24 - shipmentCount: 1 - pieceCount: 2 - weight: 200 - weightUnit: LBS - manifest: - manifestNumber: M810000091 - manifestFormat: DATA - shipper: - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - company: GEMINI SYSTEM INFORMATION - address1: 12380 MORRIS RD - address2: "" - address3: "" - city: Louisville - state: KY - postalCode: "40214" - countryCode: US - shipments: - - number: 1 - shipmentNumber: "9100010271" - serviceType: AM - paymentType: OTH/THD - weight: 54 - orderDescription: "Lots of Stuff" - currency: USD - shipperReference: Z30010021 - consigneeReference: ABC123 - consignee: - partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 - company: DHL INTERNATIONAL (UK) LTD. - address1: 99 Hereford Street - address2: "" - address3: "" - city: Cranston - state: RI - postalCode: "02920" - countryCode: US - summary: - services: - - serviceCode: CX - serviceName: UPS Express® Freight - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 55 - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - - serviceCode: D2 - serviceName: UPS 2nd Day Air® Freight NGS - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 45.2 - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - serviceTotal: - freightChargesAmount: 24.45 - surchargesAmount: 45.87 - addedChargesAmount: 33.2 - billedAmount: 100.2 - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - dailyPickupTotals: - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 - currentPickupTotals: - shipmentCount: 1 - itemCount: 1 - totalWeight: 20 + shipmentSummary: + shipmentNumber: null + confirmationId: "374680504" + quoteIdentificationNumber: "200025511" + status: "ShipmentConfirmed" + serviceLine: "LCL" + serviceType: "PF" + serviceGroup: null + movementType: "DTD" + movementTypeCode: "DTA" + rateType: "Market" + transitTime: 16 + validTill: "2024-12-24T00:00:00Z" + validity: 7 + portOfLoad: "DEP01" + portOfDischarge: "USP0B" + createdDate: "2024-12-17T05:19:25.7966667Z" + incoTermType: "DAP" + originPort: + code: "DEHAM" + name: "HAMBURG" + destinationPort: + code: "USNYC" + name: "NEW YORK" + paymentTerm: + code: "PPD" + type: "SHPR" + partyDetails: + - type: "SHPR" + accountNumber: null + isPayor: true + contactDetail: + name: null + emailAddress: null + faxNumber: null + phoneNumber: null + referenceNumber: null + address: + companyName1: null + companyName2: null + addressLine1: null + addressLine2: null + addressLine3: null + city: "HAMBURG" + stateCode: null + postalCode: null + countryCode: "DE" + companyName: null + fullAddress: null + - type: "CONS" + accountNumber: null + isPayor: false + contactDetail: + name: null + emailAddress: null + faxNumber: null + phoneNumber: null + referenceNumber: null + address: + companyName1: null + companyName2: null + addressLine1: null + addressLine2: null + addressLine3: null + city: "NEW YORK" + stateCode: "NY" + postalCode: "10000" + countryCode: "US" + companyName: null + fullAddress: null + cargoDetails: + insuredValueCurrency: "USD" + insuredValue: 5600 + customsValueCurrency: "USD" + customsValue: 5600 + commodityName: "Leather Dressings" + fclCargoItems: [] + cargoItems: + - quantity: 11 + packageType: "Pallets" + packageTypeCode: "PLT" + weightDetail: + weight: 12 + unitOfMeasurement: "kg" + dimensions: + length: 1.1 + width: 1.1 + height: 0.2 + unitOfMeasurement: "M" + pickupDetail: + date: null + startTime: null + endTime: null + chargeDetails: + - shipmentPartyType: "SHPR" + charges: + - chargeType: "OF1" + description: "OCEAN FRT. LCL" + chargeAmount: 1153.53 + currency: "USD" + - chargeType: "774" + description: "FUEL SURCHARGE - DEST" + chargeAmount: 346.06 + currency: "USD" + - chargeType: "PU" + description: "PICK UP" + chargeAmount: 215.38 + currency: "USD" + - chargeType: "90" + description: "EXPORT CUSTOMS CLEARANCE FEE" + chargeAmount: 59.23 + currency: "USD" + - chargeType: "D95" + description: "ISF FILING FEE NVO" + chargeAmount: 50 + currency: "USD" + - chargeType: "777" + description: "FUEL SURCHARGE - ORIG" + chargeAmount: 43.08 + currency: "USD" + - chargeType: "568" + description: "AMS FEE" + chargeAmount: 35 + currency: "USD" + - chargeType: "IN" + description: "INSURANCE" + chargeAmount: 25 + currency: "USD" + - shipmentPartyType: "CONS" + charges: + - chargeType: "07" + description: "CUSTOMS BROKERAGE CHARGE - DEST" + chargeAmount: 145 + currency: "USD" + - shipmentPartyType: "THRD" + charges: [] "400": description: Bad Request headers: @@ -2293,7 +2471,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2305,7 +2483,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -2321,7 +2499,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2333,36 +2511,8 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. - "404": - description: Resource Not Found - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - X-BusinessGUID: - $ref: "#/components/headers/X-BusinessGUID" - X-ClientId: - $ref: "#/components/headers/X-ClientId" - content: - application/json: - schema: - $ref: "#/components/schemas/ApolloErrorResponseV1" - example: - response: - errors: - - code: "9999" - message: The requested resource was not found. "500": description: Server Error headers: @@ -2377,7 +2527,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2389,15 +2539,256 @@ paths: example: response: errors: - - code: "1003" - message: Internal Server Error - /info/cities: - get: - operationId: getCity + - code: "-1003" + message: Internal Server Error + + /documents/manifests: + post: + summary: Create Manifest + operationId: printAirManifest tags: - Forwarding - summary: City Data - description: Retrieves city details matching the provided search criteria. + description: Generates and returns the manifest for the specified manifest number in the requested format. + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApolloPrintManifestRequestV1' + example: + accountNumber: "123456789" + manifestNumber: "M810000079" + manifestFormat: DATA + language: en-US + + responses: + "200": + description: OK + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirShipmentDataResponseV1" + example: + response: + account: "123456789" + pickupDate: 2025-07-24 + shipmentCount: 1 + pieceCount: 2 + weight: 200 + weightUnit: LBS + manifest: + manifestNumber: M810000091 + manifestFormat: DATA + shipper: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: GEMINI SYSTEM INFORMATION + address1: 12380 MORRIS RD + address2: "" + address3: "" + city: Louisville + state: KY + postalCode: "40214" + countryCode: US + shipments: + - number: 1 + shipmentNumber: "9100010271" + serviceType: AM + paymentType: OTH/THD + weight: 54 + orderDescription: "Lots of Stuff" + currency: USD + shipperReference: Z30010021 + consigneeReference: ABC123 + consignee: + partyCode: 899df6b43f5b5a7d41db2b8d4759c1e0 + company: DHL INTERNATIONAL (UK) LTD. + address1: 99 Hereford Street + address2: "" + address3: "" + city: Cranston + state: RI + postalCode: "02920" + countryCode: US + summary: + services: + - serviceCode: CX + serviceName: UPS Express® Freight + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 55 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + pieceCount: 2 + - serviceCode: D2 + serviceName: UPS 2nd Day Air® Freight NGS + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 45.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + pieceCount: 2 + serviceTotal: + freightChargesAmount: 24.45 + surchargesAmount: 45.87 + addedChargesAmount: 33.2 + billedAmount: 100.2 + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + pieceCount: 2 + dailyPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + pieceCount: 2 + currentPickupTotals: + shipmentCount: 1 + itemCount: 1 + totalWeight: 20 + pieceCount: 2 + message: Manifest generated successfully. + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: Required field missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: Invalid Authentication Information. + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-9999" + message: The requested resource was not found. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: Internal Server Error + /info/cities: + get: + operationId: getCity + tags: + - Forwarding + summary: Get Cities + description: Retrieves city details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -2415,7 +2806,7 @@ paths: required: true schema: type: string - description: Country Code. its required for this operation + description: Country Code. it's required for this operation - name: city in: query schema: @@ -2447,7 +2838,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2465,6 +2856,7 @@ paths: tariffDestination: ATL sortCode: V1 standardService: BND + message: Cities fetched successfully. "400": description: Bad Request headers: @@ -2479,7 +2871,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2491,7 +2883,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -2507,7 +2899,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2519,7 +2911,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "404": description: Resource Not Found @@ -2535,7 +2927,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2547,7 +2939,7 @@ paths: example: response: errors: - - code: "9999" + - code: "-9999" message: The requested resource was not found. "500": description: Server Error @@ -2563,7 +2955,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2575,14 +2967,14 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error /info/currencies: get: operationId: getCurrencies tags: - Forwarding - summary: Retrieves Currencies + summary: Get Currencies description: Retrieves the currency details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -2610,7 +3002,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2624,6 +3016,7 @@ paths: currencies: - currencyCode: USD currencyName: United States Dollar + message: Currencies retrieved successfully. "400": description: Bad Request headers: @@ -2638,7 +3031,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2650,7 +3043,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -2666,7 +3059,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2678,7 +3071,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "404": description: Resource Not Found @@ -2694,7 +3087,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2706,7 +3099,7 @@ paths: example: response: errors: - - code: "9999" + - code: "-9999" message: The requested resource was not found. "500": description: Server Error @@ -2722,7 +3115,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2734,7 +3127,7 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error /info/payment-types: get: @@ -2800,7 +3193,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2826,6 +3219,7 @@ paths: movementTypeCode: ATD serviceGroupName: IAF serviceLine: AIR + message: Payment types retrieved successfully. "400": description: Bad Request headers: @@ -2840,7 +3234,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2852,7 +3246,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -2868,7 +3262,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2880,7 +3274,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "404": description: Resource Not Found @@ -2896,7 +3290,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2908,7 +3302,7 @@ paths: example: response: errors: - - code: "9999" + - code: "-9999" message: The requested resource was not found. "500": description: Server Error @@ -2924,7 +3318,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2936,14 +3330,14 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error /info/countries: get: operationId: getCountries tags: - Forwarding - summary: Get Country Data + summary: Get Countries description: Retrieves country details matching the provided search criteria. parameters: - $ref: "#/components/parameters/transId" @@ -2971,7 +3365,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -2985,6 +3379,7 @@ paths: countries: - countryCode: US countryName: United States + message: Countries retrieved successfully. "400": description: Bad Request headers: @@ -2999,7 +3394,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3011,7 +3406,7 @@ paths: example: response: errors: - - code: "1001" + - code: "-1001" message: Required field missing "401": description: Unauthorized Request @@ -3027,7 +3422,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3039,7 +3434,7 @@ paths: example: response: errors: - - code: "250002" + - code: "-250002" message: Invalid Authentication Information. "404": description: Resource Not Found @@ -3055,7 +3450,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3067,7 +3462,7 @@ paths: example: response: errors: - - code: "9999" + - code: "-9999" message: The requested resource was not found. "500": description: Server Error @@ -3083,7 +3478,7 @@ paths: APIErrorCode: $ref: "#/components/headers/APIErrorCode" APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3095,11 +3490,11 @@ paths: example: response: errors: - - code: "1003" + - code: "-1003" message: Internal Server Error /info/airports: get: - summary: Get Airport Details + summary: Get Airports description: Retrieve airport details by country code. operationId: getAirportDetails tags: @@ -3155,8 +3550,8 @@ paths: $ref: "#/components/headers/Content-Type" APIErrorCode: $ref: "#/components/headers/APIErrorCode" - APIErrorMsg: - $ref: "#/components/headers/APIErrorMsg" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3183,8 +3578,8 @@ paths: $ref: "#/components/headers/Content-Type" APIErrorCode: $ref: "#/components/headers/APIErrorCode" - APIErrorMsg: - $ref: "#/components/headers/APIErrorMsg" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3211,8 +3606,8 @@ paths: $ref: "#/components/headers/Content-Type" APIErrorCode: $ref: "#/components/headers/APIErrorCode" - APIErrorMsg: - $ref: "#/components/headers/APIErrorMsg" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3288,8 +3683,8 @@ paths: $ref: "#/components/headers/Content-Type" APIErrorCode: $ref: "#/components/headers/APIErrorCode" - APIErrorMsg: - $ref: "#/components/headers/APIErrorMsg" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3316,8 +3711,8 @@ paths: $ref: "#/components/headers/Content-Type" APIErrorCode: $ref: "#/components/headers/APIErrorCode" - APIErrorMsg: - $ref: "#/components/headers/APIErrorMsg" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3344,8 +3739,8 @@ paths: $ref: "#/components/headers/Content-Type" APIErrorCode: $ref: "#/components/headers/APIErrorCode" - APIErrorMsg: - $ref: "#/components/headers/APIErrorMsg" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" X-BusinessGUID: $ref: "#/components/headers/X-BusinessGUID" X-ClientId: @@ -3359,13 +3754,1240 @@ paths: errors: - code: "-1003" message: "Internal Server Error" -components: - securitySchemes: - oauth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" + /info/accessorials: + post: + summary: Get Accessorials + description: Get accessorials by search criteria. + operationId: getAccessorials + tags: + - Forwarding + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirUtilityAccessorialsRequestV1" + example: + shipper: + city: "Prague" + state: "NJ" + "postalCode": "7702" + countryCode: "CZ" + isResidential: "Y" + consignee: + city: "TIMONIUM" + state: "NJ" + "postalCode": "7702" + countryCode: "US" + isResidential: "Y" + serviceCode: "CA" + pickupDateTime: "2025-08-11" + dropOffTime: "01:14:30" + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloAirUtilityValidAccessorialsResponseV1" + example: + response: + accessorials: + - code: "CC" + name: "CUSTOMS CLEARANCE" + + - code: "CV" + name: "CUSTOMS VALUE" + + - code: "DDU" + name: "DESTINATION DUTIES UNPAID" + + - code: "DLV" + name: "DELIVERY" + - code: "DV" + name: "DECLARED/INSURED VALUE" + + - code: "DDP" + name: "FREE DOMICILE AVAILABLE" + - code: "LIFTGT" + name: "LIFT GATE" + paymentTerms: + - type: "SHPR" + code: "COL" + desc : "COLLECT SHIPMENTS ALLOWED" + - type: "SHPR" + code: "PPD" + desc : "PREPAID" + - type: "THRD" + code: "COL" + desc : "THIRD" + nextAvailPUDate: "2026-01-09" + + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: "Required field missing" + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: "Invalid Authentication Information." + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: "Internal Server Error" + /quotes: + post: + summary: Create Quote + description: Creates a quote for air or ocean based on the provided request data. + operationId: createAirOceanQuote + tags: + - Forwarding + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloQuoteDetailRequestV1" + example: + requestType: "Air" + quoteData: + serviceType: "DF" + serviceLine: "Air" + currencyCode: "USD" + movementTypeCode: "DTD" + incoTermType: "EXW" + importCustomsBrokerageFee: "" + exportCustomsBrokerageFee: "" + paymentTerm: + type: "THRD" + code: "OTH/CON" + routing: + origin: + portCode: "" + destination: + portCode: "" + specialHandlings: [] + shipmentDetails: + insuredValueCurrency: "USD" + insuredValue: 0 + customsValueCurrency: "USD" + customsValue: 0 + commodityName: "Book" + cargoItems: + - quantity: 1 + packageType: "Pallet" + packageTypeCode: "PLT" + weight: + weight: 5 + unitOfMeasurement: "LB" + dimensions: + length: 3 + width: 8 + height: 3 + unitOfMeasurement: "in" + fclCargoItems: [] + - quantity: 1 + packageType: "Pallet" + packageTypeCode: "PLT" + weight: + weight: 2 + unitOfMeasurement: "LB" + dimensions: + length: 1 + width: 8 + height: 4 + unitOfMeasurement: "in" + fclCargoItems: [] + isHazmat: true + isReefer: true + isLithium: true + isRestricted: true + isStackable: "N" + isForkliftable: "N" + isTiltable: "N" + shipmentPartyDetail: + - type: "SHPR" + accountNumber: "999999999" + contactDetail: + name: "Zeus" + emailAddress: "test1@ups.com" + faxNumber: "" + phoneNumber: "+1-8888888888" + referenceNumber: "" + address: + companyName1: "Walmart" + companyName2: "" + addressLine1: "702 SW 8th St" + addressLine2: "Bentonville" + addressLine3: "" + city: "LOS ANGELES" + stateCode: "CA" + postalCode: "90001" + countryCode: "US" + isLoadingDockAvailable: "N" + isResidentialAddress: "N" + - type: "CONS" + accountNumber: "999999998" + contactDetail: + name: "Sheldon" + emailAddress: "test2@ups.com" + faxNumber: "" + phoneNumber: "+1-8888888778" + referenceNumber: "" + address: + companyName1: "Medtronic" + companyName2: "" + addressLine1: "99 Hereford Street" + addressLine2: "Brampton" + addressLine3: "" + city: "OTTAWA" + stateCode: "ON" + postalCode: "K1A0H5" + countryCode: "CA" + isLoadingDockAvailable: "N" + isResidentialAddress: "N" + - type: "THRD" + accountNumber: "708832704" + contactDetail: + name: "Zeus" + emailAddress: "test3@ups.com" + faxNumber: "" + phoneNumber: "" + referenceNumber: "" + address: + companyName1: "Walmart" + companyName2: "" + addressLine1: "702 SW 8th St" + addressLine2: "Bentonville" + addressLine3: "" + city: "LOS ANGELES" + stateCode: "CA" + postalCode: "90001" + countryCode: "US" + isLoadingDockAvailable: "N" + isResidentialAddress: "N" + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloQuoteDetailsResponseV1" + example: + response: + quoteSummary: + quoteId: "AEA10002864" + status: "ShipmentPending" + serviceType: "DF" + transitTime: 3 + serviceLine: "Air" + serviceGroup: "NAAF" + confirmationId: "326250024" + createDate: "2025-11-22T15:48:54.8774961Z" + netTotal: 0 + validTill: "0001-01-01T00:00:00Z" + originPort: + code: "" + name: "" + destinationPort: + code: "" + name: "" + nonConformalReasons: [] + pricingDetail: + rateType: "Market" + message: "" + currencyCode: "USD" + actualTotalPrice: 290.26 + netTotalPrice: 290.26 + discountDetail: + discount: 0 + discountPercent: 0 + discountValidTill: "2025-12-31T00:00:00Z" + estimateChargableWeight: 7 + estimateChargableWeightUnit: "lb" + chargeDetails: + - shipmentPartyType: "SHPR" + charges: + - chargeType: "AF" + chargeAmount: 176.07 + currency: "USD" + - chargeType: "35" + chargeAmount: 50 + currency: "USD" + - chargeType: "33" + chargeAmount: 43.19 + currency: "USD" + - chargeType: "83" + chargeAmount: 15 + currency: "USD" + - chargeType: "MINADJ" + chargeAmount: 6 + currency: "USD" + - shipmentPartyType: "CONS" + charges: [] + - shipmentPartyType: "THRD" + charges: + - chargeType: "961" + chargeAmount: 0 + currency: "USD" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: "Invalid request" + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: "Invalid Authentication Information." + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: "Internal Server Error" + get: + summary: Search Quotes + description: Retrieves detailed information for a specific air or ocean freight quote identified by the provided request parameters. + operationId: getQuoteDetails + tags: + - Forwarding + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: request_type + in: query + required: true + schema: + type: string + minLength: 3 + maxLength: 5 + description: Type of quote request (i.e, Air or Ocean) + example: "Air" + - name: quote_id + in: query + required: true + schema: + type: string + minLength: 9 + maxLength: 11 + example: "AEA10004706" + responses: + "200": + description: Quote details retrieved successfully + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloQuoteDataResponseV1" + example: + response: + quoteSummary: + quoteId: "AEA10004706" + status: "ShipmentPending" + confirmationId: "328250356" + shipmentNumber: "3460137351" + serviceType: "DF" + transitTime: 3 + serviceLine: "Air" + serviceGroup: "NAAF" + movementTypeCode: "DTD" + incoTermType: "EXW" + createDate: "2025-11-24T07:24:41.1456919" + netTotal: 0 + validTill: "0001-01-01T00:00:00" + validity: 0 + originPort: + portCode: "" + portName: "" + serviceType: "" + serviceCenterCode: "" + serviceRatedOverCode: "" + destinationPort: + portCode: "" + portName: "" + serviceType: "" + serviceCenterCode: "" + serviceRatedOverCode: "" + portOfLoad: "" + portOfDischarge: "" + pricingDetail: + rateType: "Market" + rateDescription: "Applied Market Rates For PA, as published rates (GCNAAF) were resolved for 'AF' charge" + currencyCode: "USD" + actualTotalPrice: 535.26 + netTotalPrice: 535.26 + discountDetail: + discount: 0 + discountPercent: 0 + eligibleDiscount: 0 + eligibleDiscountPercent: 0 + discountAdjustedFor: "" + discountValidTill: "" + estimateChargableWeight: 7 + estimateChargableWeightUnit: "lb" + chargeDetails: + - shipmentPartyType: "SHPR" + charges: [] + - shipmentPartyType: "CONS" + charges: [] + - shipmentPartyType: "THRD" + charges: + - chargeType: "961" + description: "NON-CONFORMING CARGO" + chargeAmount: 245 + currency: "USD" + originalChargeAmount: "" + - chargeType: "AF" + description: "AIR FREIGHT" + chargeAmount: 176.07 + currency: "USD" + originalChargeAmount: "" + - chargeType: "35" + description: "CANADIAN IMPORT TERMINATION FEE" + chargeAmount: 50 + currency: "USD" + originalChargeAmount: "" + - chargeType: "33" + description: "FUEL-INDEX" + chargeAmount: 43.19 + currency: "USD" + originalChargeAmount: "" + - chargeType: "83" + description: "US EXPORT COMPLIANCE FEE" + chargeAmount: 15 + currency: "USD" + originalChargeAmount: "" + - chargeType: "MINADJ" + description: "MINIMUM INVOICE ADJUSTMENT" + chargeAmount: 6 + currency: "USD" + originalChargeAmount: "" + paymentTerm: + type: "THRD" + code: "OTH/CON" + shipmentPartyDetail: + - type: "THRD" + accountNumber: "708832704" + contactDetail: + name: "Zeus" + emailAddress: "pkunja@ups.com" + faxNumber: "" + phoneNumber: "" + referenceNumber: "" + address: + companyName1: "Walmart" + companyName2: "" + addressLine1: "7500 CENTURION PARKWAY" + addressLine2: " " + addressLine3: "" + city: "JACKSONVILLE" + stateCode: "FL" + postalCode: "32256" + countryCode: "US" + isLoadingDockAvailable: "" + isResidentialAddress: "" + - type: "SHPR" + accountNumber: "" + contactDetail: + name: "Zeus" + emailAddress: "pkunja@ups.com" + faxNumber: "" + phoneNumber: "+1-8888888888" + referenceNumber: "" + address: + companyName1: "Walmart" + companyName2: "" + addressLine1: "702 SW 8th St" + addressLine2: "Bentonville" + addressLine3: "" + city: "LOS ANGELES" + stateCode: "CA" + postalCode: "90001" + countryCode: "US" + isLoadingDockAvailable: "" + isResidentialAddress: "" + - type: "CONS" + accountNumber: "" + contactDetail: + name: "Sheldon" + emailAddress: "pkunja@ups.com" + faxNumber: "" + phoneNumber: "+1-8888888778" + referenceNumber: "" + address: + companyName1: "Medtronic" + companyName2: "" + addressLine1: "99 Hereford Street" + addressLine2: "Brampton" + addressLine3: "" + city: "OTTAWA" + stateCode: "ON" + postalCode: "K1A0H5" + countryCode: "CA" + isLoadingDockAvailable: "" + isResidentialAddress: "" + shipmentDetails: + insuredValuecurrency: "USD" + insuredValue: 0 + customsValuecurrency: "USD" + customsValue: 0 + commodityName: "Books" + fclCargoItems: [] + lclCargoItems: [] + airCargoItems: + - quantity: 1 + weight: + weight: 5 + unitOfMeasurement: "lb" + dimensions: + length: 3 + width: 8 + height: 3 + unitOfMeasurement: "in" + - quantity: 1 + weight: + weight: 2 + unitOfMeasurement: "lb" + dimensions: + length: 1 + width: 8 + height: 4 + unitOfMeasurement: "in" + location: + - portCode: "" + portName: "" + serviceType: "Origin" + serviceCenterCode: "LAX" + serviceRatedOverCode: "LAX" + - portCode: "" + portName: "" + serviceType: "Destination" + serviceCenterCode: "YOW" + serviceRatedOverCode: "YOW" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: "Invalid request" + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: "Invalid Authentication Information." + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: "Internal Server Error" + patch: + summary: Book Quote + description: Creates a booking for air or ocean based on the provided request data. + operationId: airOceanBookQuote + tags: + - Forwarding + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApolloQuoteBookingRequestV1' + example: + quoteId: "AEA10004658" + specialInstructions: "hello" + pickupDetails: + date: "2025-11-25" + startTime: "10:12" + endTime: "12:22" + requestType: "Air" + responses: + "200": + description: Successful booking response + content: + application/json: + schema: + $ref: '#/components/schemas/ApolloBookingResponseV1' + example: + response: + quoteBookSummary: + quoteId: "AEA10004707" + status: "ShipmentInitiated" + shipmentNumber: "3460137373" + confirmationId: "328250372" + bookingReference: "" + createDate: "2025-11-24T07:26:58.4170418" + cargoDetails: + isStackable: "Y" + isForkliftable: "N" + isTiltable: "Y" + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: "Invalid request" + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: "Invalid Authentication Information." + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: "Internal Server Error" + /shipments/milestones: + get: + description: Get shipment milestones from tracking service. + summary: Track Shipments + operationId: getShipmentMilestones + tags: + - Forwarding + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/X-BusinessGUID" + - $ref: "#/components/parameters/X-ClientId" + - name: business_id + in: query + required: true + schema: + type: string + maxLength: 20 + description: "The unique business identifier associated with the shipment." + example: "COSTCO" + - name: ups_file_number + in: query + required: false + schema: + type: string + maxLength: 23 + description: "The UPS file number assigned to the shipment." + example: "158599901829110" + - name: ups_office + in: query + required: false + schema: + type: string + maxLength: 5 + description: "The UPS office code handling the shipment." + example: "2106" + - name: ups_shipment_number + in: query + required: true + schema: + type: string + minLength: 5 + maxLength: 20 + description: "The UPS shipment number for tracking purposes." + example: "5358629782" + responses: + '200': + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + description: Successful retrieval of full tracking details + content: + application/json: + schema: + $ref: '#/components/schemas/ApolloFullTrackingDetailsResponseV1' + example: + response: + primaryInformation: + id: "5358629782.primary-information" + shipmentNumber: "5358629782" + upsFileNumber: "158599901829110" + upsOffice: "2106" + upsDatasource: "E2KEX" + shipper: "SAMSUNG SDS GSCL CANADA LTD" + destinationConsignee: "COSTCO DEPOT VARENNES 573 574 946" + principal: "SAMSUNG SDSGSCL CANADA LTD OUTBOUND" + proofOfDelivery: "John Smith" + podDateTime: "2025-01-10T14:30:00Z" + shipmentType: "Air" + shipmentServiceLevel: "UPS 3 Day Air Freight Non Guaranteed" + modeOfTransportCode: "A" + modeOfTransportName: "Air" + primaryException: "" + shipmentBookedDateTime: "2025-01-01T10:00:00Z" + shipmentCreateDateTime: "2025-01-01T09:00:00Z" + originalScheduledDeliveryDateTime: "2025-01-10T12:00:00Z" + latestScheduledDeliveryDateTime: "2025-01-10T12:00:00Z" + product: "UPS Air Freight" + actualDeliveryDateTime: "2025-01-10T14:30:00Z" + milestoneStatus: "Delivered" + shipmentLatestStatusDateTime: "2025-01-10T14:30:00Z" + lastKnownLocation: "Atlanta, GA" + consigneeReferenceNumber: + - referenceType: "CONS_REF" + referenceNumber: "CONS123" + customerPONumber: + - referenceType: "PO" + referenceNumber: "PO987654" + references: + - code: "REF001" + type: "Customer Reference" + number: "CUST123456" + createdDate: "2025-01-01T09:00:00Z" + shipmentAdditionalInformation: + shipmentCategory: "General Cargo" + quantity: "10" + itemDescription: "Electronic Equipment" + incoterms: "DAP" + freightPaymentTerm: "Prepaid" + actualWeight: + weight: "500" + uomCode: "KG" + uomLabel: "Kilograms" + chargeableWeight: + weight: "550" + uomCode: "KG" + uomLabel: "Kilograms" + shipmentVolume: + volume: "2.5" + uomCode: "CBM" + uomLabel: "Cubic Meters" + shipmentOrigin: + addressLine1: "123 Industrial Blvd" + addressLine2: "Suite 100" + city: "Los Angeles" + stateProvince: "CA" + postalCode: "90001" + country: "US" + unloc: "USLAX" + shipmentDestination: + addressLine1: "456 Commerce St" + addressLine2: "Building A" + city: "Atlanta" + stateProvince: "GA" + postalCode: "30303" + country: "US" + unloc: "USATL" + flightVoyageInformation: + - leg: "1" + displayDepartureLocation: "Los Angeles (LAX)" + displayArrivalLocation: "Atlanta (ATL)" + carrierCode: "UA" + carrierName: "United Airlines" + vessel: "Boeing 777" + flightVoyageNumber: "UA1234" + estimateDepartureDateTime: "2025-01-02T08:00:00Z" + confirmedDepartureDateTime: "2025-01-02T08:15:00Z" + estimatedArrivalDateTime: "2025-01-02T16:00:00Z" + confirmedArrivalDateTime: "2025-01-02T15:45:00Z" + masterBill: "MASTER123456" + milestones: + shipmentMilestones: + - id: "M001" + label: "Picked Up" + milestoneCompletionDateTime: "2025-01-01T14:00:00Z" + milestoneUNLOC: "USLAX" + - id: "M002" + label: "In Transit" + milestoneCompletionDateTime: "2025-01-02T08:15:00Z" + milestoneUNLOC: "USLAX" + - id: "M003" + label: "Delivered" + milestoneCompletionDateTime: "2025-01-10T14:30:00Z" + milestoneUNLOC: "USATL" + shipmentExceptionDetails: + exceptionCount: "0" + exceptionList: [] + containerInformation: + - containerNumber: "CONT123456" + containerType: "Pallet" + containerDescription: "Standard Air Pallet" + seal: "SEAL789" + quantity: "10" + containerWeight: + weight: "500" + uomCode: "KG" + uomLabel: "Kilograms" + containerVolume: + volume: "2.5" + uomCode: "CBM" + uomLabel: "Cubic Meters" + contactInfo: + - role: "SHPR" + roleName: "Shipper" + account: "123456" + businessId: "BUS123456" + name: "ABC Company" + phone: "+1-555-1234" + attention: "Shipping Department" + address: + street: "123 Industrial Blvd" + city: "Los Angeles" + stateProvince: "CA" + postalCode: "90001" + country: "US" + unloc: "USLAX" + "404": + description: Resource Not Found + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "9999" + message: The requested shipment was not found. + "400": + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1001" + message: Required field is missing + "401": + description: Unauthorized Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-250002" + message: Invalid Authentication Information. + "500": + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMessage" + X-BusinessGUID: + $ref: "#/components/headers/X-BusinessGUID" + X-ClientId: + $ref: "#/components/headers/X-ClientId" + content: + application/json: + schema: + $ref: "#/components/schemas/ApolloErrorResponseV1" + example: + response: + errors: + - code: "-1003" + message: Internal Server Error +components: + securitySchemes: + oauth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" 2. In the Security section enter your Client ID and Secret 3. Select "Request Token" 4. Enter any additional information in the Body and Parameters sections @@ -3565,7 +5187,7 @@ components: schema: type: string example: UJ0001 - APIErrorMsg: + APIErrorMessage: description: The API error message. required: true schema: @@ -3592,2092 +5214,4161 @@ components: description: Request to generate Air Freight rates for a shipment. type: object required: - - shipper - - consignee - - shipment + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloPartyV1" + consignee: + $ref: "#/components/schemas/ApolloPartyV1" + thirdParty: + $ref: "#/components/schemas/ApolloPartyV1" + shipment: + type: object + description: Shipment information for rate calculation. + required: + - serviceType + - paymentType + - freightType + - items + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + type: + - string + - "null" + enum: + - AMG + - AM + - D2G + + + - D2 + - DFG + + + - DF + - CX + + + - CA + + - EC + + + paymentType: + type: string + description: Payment type. + oneOf: + - title: Prepaid + const: PPD + - title: Collect + const: COL + - title: Third Party + const: OTH/THD + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The RFC 3339 pickup ready time. + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The RFC 3339 location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The RFC 3339 shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. + format: float + maximum: 999999.99 + examples: + - 54 + - 10.32 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + - LOOSE + isMetric: + type: boolean + description: Indicates whether the shipment uses metric units of measurement. + default: false + orderDescription: + type: string + description: Description of the shipment. + example: Shipment of electronics + shipperReference: + type: string + description: Reference number provided by the shipper. + example: SHIP123 + consigneeReference: + type: string + description: Reference number provided by the consignee. + example: CON123 + currencyCode: + type: string + description: The ISO 4217 shipment currency code + minLength: 3 + maxLength: 3 + pattern: '^[A-Z]{3}' + example: USD + requestPickup: + type: boolean + description: Indicates whether a pickup request is included. + default: false + requestBoL: + type: boolean + description: Indicates whether a Bill of Lading (BoL) is requested. + default: false + countryOfManufacture: + type: array + description: The unbounded list of country codes where the goods were manufactured. + minItems: 1 + items: + description: | + The ISO 3166 + code of the country participating in the goods manufacture. + $ref: "#/components/schemas/ApolloCountryCodeV1" + items: + type: array + description: Unbounded list of items in the shipment. + minItems: 1 + items: + type: object + description: Item information within a shipment. + required: + - count + - length + - width + - height + - weight + properties: + description: + type: string + description: Description of the item. + example: Laptop + count: + type: integer + description: Quantity of the item. + maximum: 99999 + example: 1 + length: + description: Length of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + width: + description: Width of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + height: + description: Height of the item. + $ref: "#/components/schemas/ApolloDimensionV1" + weight: + type: number + format: float + description: Weight of the item. + minimum: 0.1 + maximum: 999999.99 + examples: + - 15 + - 6.84 + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + language: + type: string + description: Language preference for the response. + example: en-US + transactionId: + type: string + description: Unique transaction ID for debugging and tracking. + example: N29245123456789 + additionalProperties: false + ApolloAirFreightRateResponseV1: + type: object + description: This object provides the rate calculation response. + required: + - response + properties: + response: + type: object + required: + - rates + properties: + rates: + type: array + description: Unbounded list of calculated rates. + minItems: 1 + items: + type: object + description: Details of a calculated rate. + required: + - serviceType + - guaranteedDelivery + - deliveryTime + - holdAtAirportTime + - totalCharge + - billableWeight + - weightUnit + - dimensionalWeight + - minimumBillableWeightApplied + - contractRate + - charges + properties: + serviceType: + type: string + description: Service type for the rate. + example: AM + guaranteedDelivery: + type: boolean + description: Indicates if delivery is guaranteed. + default: false + deliveryTime: + description: The estimated delivery time. + $ref: "#/components/schemas/ApolloDateTimeV1" + holdAtAirportTime: + description: The hold at airport time. + $ref: "#/components/schemas/ApolloDateTimeV1" + totalCharge: + description: Total charge for the shipment. + $ref: "#/components/schemas/ApolloChargeAmountV1" + billableWeight: + description: The billable weight. + $ref: "#/components/schemas/ApolloWeightV1" + weightUnit: + type: string + description: The Weight unit used. + enum: + - LBS + - KGS + dimensionalWeight: + description: The dimensional weight. + $ref: "#/components/schemas/ApolloWeightV1" + minimumBillableWeightApplied: + type: boolean + description: Indicates if the minimum billable weight was applied. + default: false + contractRate: + type: boolean + description: Indicates if the contract rate applies. + default: false + charges: + type: array + minItems: 1 + description: Unbounded list of charges applied + items: + type: object + properties: + role: + type: string + description: The role of charge + example: Carrier + code: + type: string + description: The charge code + example: FRT + description: + type: string + description: The charge Description + example: Air Freight Shipping - Included + amount: + type: number + description: The charge amount + example: 250.75 + currencyCode: + type: string + description: The type of currency associated with the charge + example: USD + includedInd: + type: + - string + - "null" + description: Indicates if the charge is included in total charge + example: "N" + additionalProperties: false + additionalProperties: false + + #/air/orders + ApolloOrderRequestV1: + type: object + description: The object that holds the data to create an Order. Following fields will be examined for the Shipment Consolidation(when enabled)- consolidationId, shipper, pickupDate, consignee, serviceType, paymentType, IsHAPU, IsSaturdayPickup, IsLiftgatePickup, IsLiftgateDelivery, Pickup, DLV, IsFreeDomicileDDU, IsFreeDomicileDDP, IsCustomsClearance, CustomValueCurrencyCode, CustomValue, RESPU, RESDLV, freightType, IsHazMat, orderDescription, DeclaredValueCurrencyCode, DeclaredValue, IsMetric, ThirdParty + required: + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Shipper associated with the Shipment. UPS Freight Account Number is required. + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Consignee associated with the Shipment. UPS Freight Account Number is required if the consignee is the payor. must be different Shipper. Consolidation Key - Consolidation keys should be Identical with previous orders to get consolidated + thirdParty: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: Any other Party involved in the Shipment, usually a payor. Details Required when third party is payor, must be different from consignee and shipper + shipment: + type: object + required: + - pickupDate + - freightType + - items + - currency + - isMetric + - paymentType + - serviceType + - orderDescription + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + type: + - string + - "null" + enum: + - AMG + - AM + - D2G + - D2 + - DFG + - DF + - CX + - CA + - EC + - MEXDF + - SAT + - SATG + - GOLDP + - CXD + - CXC + - CXCD + - CAD + - CAC + - CACD + - ECD + - ECC + - ECCD + - EG + - EA + example: AM + description: Type of service requested + maxLength: 6 + paymentType: + type: + - string + - "null" + maxLength: 10 + example: PPD + enum: + - PPD + - COL + - OTH/THD + pickupDate: + description: The RFC 3339 scheduled pickup date. The date must be in "mm/dd/yyyy" or "yyyy-mm-dd" format. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The pickup ready time. The time window between ready time and close time must be at least 30 minutes. For pickups scheduled today, the ready time must be at least 30 minutes after the current local time. The pickup date cannot be earlier than today's local date + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. Required if items are missing weight entry + format: float + maximum: 99999 + example: 54 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + - LOOSE + orderDescription: + description: A short description of the Shipment Order + type: + - string + - "null" + example: WIDGETS + maxLength: 30 + shipperReference: + description: A reference to the shipment provided by the Shipper + type: + - string + - "null" + example: ABC123 + maxLength: 30 + consigneeReference: + description: A reference to the shipment provided by the Consignee + type: + - string + - "null" + example: Z30010021 + maxLength: 30 + currency: + description: The currency code associated with the Shipment. Default is USD + type: + - string + - "null" + example: USD + default: USD + isMetric: + description: A flag to indicate if the measurements are metric + type: + - boolean + - "null" + default: false + items: + type: array + description: A collection of the details of each item that is associated with the Shipment + minItems: 1 + items: + $ref: "#/components/schemas/ApolloItemV1" + countryOfManufacture: + description: An unbounded array of country codes where the items originated + minItems: 1 + type: array + items: + type: + - string + - "null" + maxLength: 3 + example: US + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + description: Some of the keys include but not limited to are IsHazMat, IsHazMatPassengerAircraft, HAZMAT-Instruction, IsHAPU, ContactName, ContactPhone, IsSaturdayPickup, IsCustomsClearance, DeclaredValue, DeclaredValueCurrencyCode, CustomsValue, CustomsValueCurrencyCode, PICKUP, IsFreeDomicileDDU, IsFreeDomicileDDP, RESPU, RESDLV, IsLiftgatePickup, IsLiftgateDelivery, GovernmentBoLNumber, RemarksToConsignee + additionalProperties: false + label: + type: object + required: + - format + properties: + layout: + description: A key that determines the template that is used for the label. + type: + - string + - "null" + maxLength: 40 + example: AF-GEMINI + default: AF-GEMINI + format: + description: The output format of the document. + type: + - string + - "null" + enum: + - PDF + - PNG + - JPG + - BMP + - TIFF + - SVG + - DATA + details: + description: Additional details needed for the label. May include the custom fields that the label template supports + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + language: + description: The language/culture that is being used for the API + type: string + maxLength: 6 + transId: + description: A transaction Id to track this API call + type: string + additionalProperties: false + ApolloOrderResponseV1: + type: object + description: Response from the Order API + required: + - response + properties: + response: + allOf: + - $ref: "#/components/schemas/ApolloLabelV1" + - type: object + required: + - shipmentNumber + - orderNumber + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: true + ApolloCancelOrderRequestV1: + description: The request used to cancel an Order + type: object + required: + - account + - orderNumber properties: - shipper: - $ref: "#/components/schemas/ApolloPartyV1" - consignee: - $ref: "#/components/schemas/ApolloPartyV1" - thirdParty: - $ref: "#/components/schemas/ApolloPartyV1" - shipment: + account: + description: The unique number that identifies the Shipment + type: + - string + - "null" + example: "123456789" + maxLength: 9 + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + language: + description: The language/culture that is being used for the API + type: string + maxLength: 6 + example: en-US + additionalProperties: false + ApolloCancelOrderResponseV1: + type: object + description: The response from Order Cancel Operation + required: + - response + properties: + response: type: object - description: Shipment information for rate calculation. required: - - paymentType - - freightType - - items + - shipmentNumber + - orderNumber properties: shipmentNumber: $ref: "#/components/schemas/ApolloShipmentNumberV1" - serviceType: - type: string - description: Type of service requested - oneOf: - - title: Next Day Non-Guaranteed - const: AM - - title: Next Day Guaranteed - const: AMG - - title: Second Day Non-Guaranteed - const: D2 - - title: Second Day Guaranteed - const: D2G - - title: Three Day Non-Guaranteed - const: DF - - title: Three Day Guaranteed - const: DFG - - title: Direct - const: CA - - title: Consolidated - const: EC - - title: Premium - const: CX - paymentType: + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: type: string - description: Payment type. - oneOf: - - title: Prepaid - const: PPD - - title: Collect - const: COL - - title: Third Party - const: THD - pickupDate: - description: The RFC 3339 scheduled pickup date. + additionalProperties: false + + #/air/orders/print-label + ApolloOrderPrintLabelRequestV1: + description: The API request used to print a Label + type: object + required: + - shipperAccountNumber + - orderNumber + + + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + layout: + description: A key that determines the template that is used for the label. + type: + - string + - "null" + minLength: 1 + maxLength: 40 + example: AF-GEMINI + default: AF-GEMINI + format: + description: The output format of the document. + type: + - string + - "null" + minLength: 1 + example: PDF + default: PDF + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + + #/air/orders/set-date: + # ApolloOrderSetDateRequestV1: + # $ref: "#/components/schemas/ApolloPatchReplaceReqV1" + # additionalProperties: false + ApolloOrderSetDateResponseV1: + description: The response from the date change operation + type: object + required: + - response + properties: + response: + type: + - object + - "null" + required: + - shipmentNumber + - orderNumber + - newDate + properties: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + newDate: + description: The RFC 3339 scheduled pickup date. $ref: "#/components/schemas/ApolloDateV1" - readyTime: - description: The RFC 3339 pickup ready time. - $ref: "#/components/schemas/ApolloTimeV1" - closeTime: - description: The RFC 3339 location close time. - $ref: "#/components/schemas/ApolloTimeV1" - dropoffTime: - description: The RFC 3339 shipment dropoff time. - $ref: "#/components/schemas/ApolloTimeV1" - weight: - type: number - description: Total weight of the shipment. - format: float - maximum: 999999.99 - examples: - - 54 - - 10.32 - freightType: - type: string - description: Freight type of the shipment. - enum: - - PALLET - - LOOSE - isMetric: - type: boolean - description: Indicates whether the shipment uses metric units of measurement. - default: false - description: - type: string - description: Description of the shipment. - example: Shipment of electronics - shipperReference: - type: string - description: Reference number provided by the shipper. - example: SHIP123 - consigneeReference: - type: string - description: Reference number provided by the consignee. - example: CON123 - currencyCode: + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: type: string - description: The ISO 4217 shipment currency code - minLength: 3 - maxLength: 3 - pattern: '^[A-Z]{3}' - example: USD - requestPickup: - type: boolean - description: Indicates whether a pickup request is included. - default: false - requestBoL: - type: boolean - description: Indicates whether a Bill of Lading (BoL) is requested. - default: false - countryOfManufacture: - type: array - description: The unbounded list of country codes where the goods were manufactured. - minItems: 1 - items: - description: | - The ISO 3166 - code of the country participating in the goods manufacture. - $ref: "#/components/schemas/ApolloCountryCodeV1" - items: + + #/air/orders/search + ApolloOrderSearchRequestV1: + type: object + required: + - shipperAccountNumber + - criteriaList + properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + criteriaList: + description: An array of search criteria + type: + - array + - "null" + minItems: 1 + maxItems: 12 + items: + type: + - object + - "null" + required: + - criteriaField + - criteriaOperator + - criteriaValue + properties: + criteriaField: + description: The field that is used for search + type: + - string + - "null" + minLength: 1 + example: SHIP_DATE + criteriaOperator: + description: The Operator used in the search + type: + - string + - "null" + minLength: 1 + example: BTWN + criteriaValue: + description: The value that is used in the search + type: + - string + - "null" + minLength: 1 + example: "8" + criteriaValue2: + description: The value that is used in the search + type: + - string + - "null" + minLength: 1 + example: 2025-07-23 + additionalProperties: false + language: + description: The language/culture used in the request + type: + - string + - "null" + example: en-US + additionalProperties: false + ApolloOrderSearchResponseV1: + description: The response provided by the Apollo Order Search API + type: object + required: + - response + properties: + response: + type: object + required: + - orders + properties: + orders: type: array - description: Unbounded list of items in the shipment. minItems: 1 + maxItems: 5000 items: - type: object - description: Item information within a shipment. + type: + - object + - "null" required: - - count - - length - - width - - height - - weight + - shipmentNumber + - orderNumber + - consignee + - shipDate + - statusCode + - status + - description + - manifestNumber + - shipperReference + - consigneeReference + - isMetric + - items properties: - description: - type: string - description: Description of the item. - example: Laptop - count: + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + description: The consignee associated with the Shipment + shipDate: + description: The RFC 3339 scheduled ship date. + $ref: "#/components/schemas/ApolloDateV1" + statusCode: + description: TThe code indicating the status of the Order type: integer - description: Quantity of the item. - maximum: 99999 - example: 1 - length: - description: Length of the item. - $ref: "#/components/schemas/ApolloDimensionV1" - width: - description: Width of the item. - $ref: "#/components/schemas/ApolloDimensionV1" - height: - description: Height of the item. - $ref: "#/components/schemas/ApolloDimensionV1" - weight: - type: number - format: float - description: Weight of the item. - minimum: 0.1 - maximum: 999999.99 - examples: - - 15 - - 6.84 - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" + format: int32 + minLength: 1 + minimum: 1 + example: 8 + status: + description: The description of the status of the Order + type: + - string + - "null" + minLength: 1 + example: POSTED + description: + description: The description of the Order + type: + - string + - "null" + minLength: 1 + example: Lots of stuff + manifestNumber: + description: The unique Id to identify the Manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + shipperReference: + description: The reference provided by Shipper + type: + - string + - "null" + minLength: 1 + example: SHIPPER REF + consigneeReference: + description: The reference provided by Consignee + type: + - string + - "null" + minLength: 1 + example: CONSIGNEE REF + isMetric: + description: The flag indicating whether the measurements are metric + type: boolean + default: false + items: + type: object + required: + - totalWeight + - weightUnit + - totalPieceCount + properties: + totalWeight: + description: The total weight of the Items in the Order + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 14 + weightUnit: + description: The units used to calculate weight + type: + - string + - "null" + enum: + - LB + totalPieceCount: + description: The total number of Pieces in the Order + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + item: + description: The unbounded array of individual items in the Order + type: array + minItems: 1 + items: + type: + - object + - "null" + required: + - count + - length + - width + - height + - weight + properties: + count: + description: The number of components in the item + type: integer + format: int32 + minimum: 1 + + example: 1 + length: + description: The length of each component in the item + type: number + format: float + minimum: 1 + + example: 10 + width: + description: The width of each component in the item + type: number + format: float + minimum: 1 + + example: 10 + height: + description: The height of each component in the item + type: number + format: float + minimum: 1 + + example: 10 + weight: + description: The weight of each component in the item + type: number + format: float + minimum: 1 + + example: 10 + additionalProperties: false + additionalProperties: false additionalProperties: false - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false - language: - type: string - description: Language preference for the response. - example: en-US - transactionId: - type: string - description: Unique transaction ID for debugging and tracking. - example: N29245123456789 - additionalProperties: false - ApolloAirFreightRateResponseV1: + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: true + + #/air/shipment + # ApolloAirShipmentSubmitRequestV1: + # $ref: "#/components/schemas/ApolloPatchReplaceReqV1" + # additionalProperties: false + + ApolloAirShipmentDataResponseV1: type: object - description: This object provides the rate calculation response. - required: - - response - properties: + description: Response from the Shipment API + required: + - response + properties: response: type: object required: - - rates + - account + - pickupDate + - shipmentCount + - pieceCount + - weight + - weightUnit + - manifest properties: - rates: - type: array - description: Unbounded list of calculated rates. - minItems: 1 - items: - type: object - description: Details of a calculated rate. - required: - - serviceType - - guaranteedDelivery - - deliveryTime - - holdAtAirportTime - - totalCharge - - billableWeight - - weightUnit - - dimensionalWeight - - minimumBillableWeightApplied - - contractRate - - charges - properties: - serviceType: - type: string - description: Service type for the rate. - example: AM - guaranteedDelivery: - type: boolean - description: Indicates if delivery is guaranteed. - default: false - deliveryTime: - description: The estimated delivery time. - $ref: "#/components/schemas/ApolloDateTimeV1" - holdAtAirportTime: - description: The hold at airport time. - $ref: "#/components/schemas/ApolloDateTimeV1" - totalCharge: - description: Total charge for the shipment. - $ref: "#/components/schemas/ApolloChargeAmountV1" - billableWeight: - description: The billable weight. - $ref: "#/components/schemas/ApolloWeightV1" - weightUnit: - type: string - description: The Weight unit used. - enum: - - LBS - - KGS - dimensionalWeight: - description: The dimensional weight. - $ref: "#/components/schemas/ApolloWeightV1" - minimumBillableWeightApplied: - type: boolean - description: Indicates if the minimum billable weight was applied. - default: false - contractRate: - type: boolean - description: Indicates if the contract rate applies. - default: false - charges: - type: array - minItems: 1 - description: Unbounded list of charges applied - items: - type: object - properties: - role: - type: string - description: The role of charge - example: Carrier - code: - type: string - description: The charge code - example: FRT - description: - type: string - description: The charge Description - example: Air Freight Shipping - Included - amount: + account: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + shipmentCount: + description: The count of all Shipments that are submitted for processing + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + pieceCount: + description: The count of all pieces in all the shipments submitted + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 2 + weight: + description: The total weight of all the shipments + type: number + format: float + minimum: 1 + minLength: 1 + example: 2 + weightUnit: + description: The unit used to measure the weight + type: + - string + - "null" + manifest: + description: The manifest data that is returned if the format chosen is data + type: object + required: + - manifestNumber + - manifestFormat + - shipper + - shipments + properties: + manifestNumber: + description: The unique number used to identify a manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + manifestFormat: + description: The output format of the manifest + type: + - string + - "null" + minLength: 1 + example: PDF + shipper: + $ref: "#/components/schemas/ApolloShipmentAddressV1" + shipments: + description: An array of shipment details included in the manifest + type: + - array + - "null" + items: + type: + - object + - "null" + required: + - number + - shipmentNumber + - serviceType + - paymentType + - weight + - currency + - consignee + properties: + number: + description: The index of the shipment + type: integer + format: int32 + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + description: The service type used in the Shipment + type: + - string + - "null" + minLength: 1 + example: AM + paymentType: + description: The Payment type used in the shipment + type: + - string + - "null" + minLength: 1 + example: PPD + weight: + description: The total weight of the shipment + type: number + format: float + minLength: 1 + minimum: 1 + example: 10 + orderDescription: + description: A short description of the Order + type: + - string + - "null" + minLength: 1 + example: WIDGETS + currency: + description: The currency used in the shipment + type: + - string + - "null" + minLength: 3 + maxLength: 3 + example: USD + shipperReference: + description: The reference provided by the shipper for the shipment + type: + - string + - "null" + minLength: 1 + example: ABC123 + consigneeReference: + description: The reference provided by the consignee for the shipment + type: + - string + - "null" + minLength: 1 + example: Z30010021 + consignee: + $ref: "#/components/schemas/ApolloShipmentAddressV1" + additionalProperties: false + summary: + type: object + required: + - services + - serviceTotal + - dailyPickupTotals + - currentPickupTotals + properties: + services: + description: The services used by the shipments and associated details + type: + - array + - "null" + items: + type: + - object + - "null" + required: + - shipmentCount + - itemCount + - totalWeight + - freightChargesAmount + - surchargesAmount + - addedChargesAmount + - billedAmount + - serviceCode + - serviceName + - pieceCount + properties: + shipmentCount: + description: number of shipments using this service associated with this manifest + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + itemCount: + description: The total number items in those shipments + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + totalWeight: + description: The total weight of the items + type: number + format: double + minLength: 1 + minimum: 1 + example: 3 + freightChargesAmount: + description: The total charges for this service + $ref: "#/components/schemas/ApolloAmountV1" + surchargesAmount: + description: The total surcharges for this service associated with this manifest + $ref: "#/components/schemas/ApolloAmountV1" + addedChargesAmount: + description: The total added charges for this service associated with this manifest + $ref: "#/components/schemas/ApolloAmountV1" + billedAmount: + description: Total Billed amount for this service + $ref: "#/components/schemas/ApolloAmountV1" + serviceCode: + description: The code for this service + type: + - string + - "null" + enum: + - AMG + - AM + - D2G + - D2 + - DFG + - DF + - CX + - CA + - EC + - MEXDF + - SAT + - SATG + - GOLDP + - CXD + - CXC + - CXCD + - CAD + - CAC + - CACD + - ECD + - ECC + - ECCD + - EG + - EA + minLength: 1 + example: "AM" + serviceName: + description: The name of the service + type: + - string + - "null" + minLength: 1 + example: "Next Day Air Early AM" + pieceCount: + description: The total number pieces for this service + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + additionalProperties: false + serviceTotal: + type: object + description: The total for all services + required: + - shipmentCount + - itemCount + - totalWeight + - freightChargesAmount + - surchargesAmount + - addedChargesAmount + - billedAmount + - pieceCount + properties: + shipmentCount: + description: The total number of shipments + type: integer + format: int32 + itemCount: + description: The total count of shipments + type: integer + format: int32 + pieceCount: + description: The count of all pieces in all the shipments submitted + type: integer + format: int32 + minLength: 1 + minimum: 1 + example: 3 + totalWeight: + description: The total weight of shipments type: number - description: The charge amount - example: 250.75 - currencyCode: - type: string - description: The type of currency associated with the charge - example: USD - additionalProperties: false - additionalProperties: false - - #/air/orders - ApolloOrderRequestV1: - type: object - required: - - shipper - - consignee - - shipment - properties: - shipper: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: Shipper associated with the Shipment. - consignee: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: Consignee associated with the Shipment. UPS Freight Account Number is required if the consignee is the payor. must be different Shipper - thirdParty: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: Any other Party involved in the Shipment, usually a payor. Details Required when third party is payor, must be different from consignee and shipper - shipment: - type: object - required: - - pickupDate - - freightType - - items - - currency - - isMetric - - paymentType - - serviceType - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - serviceType: - type: - - string - - "null" - enum: - - AMG - - AM - - D2G - - D2 - - DFG - - DF - - CX - - CA - - EC - - MEXDF - - SAT - - SATG - - GOLDP - - CXD - - CXC - - CXCD - - CAD - - CAC - - CACD - - ECD - - ECC - - ECCD - - EG - - EA - example: AM - description: Type of service requested - maxLength: 6 - paymentType: - type: - - string - - "null" - maxLength: 10 - example: PPD - pickupDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" - readyTime: - description: The pickup ready time. - $ref: "#/components/schemas/ApolloTimeV1" - closeTime: - description: The location close time. - $ref: "#/components/schemas/ApolloTimeV1" - dropoffTime: - description: The shipment dropoff time. - $ref: "#/components/schemas/ApolloTimeV1" - weight: - type: number - description: Total weight of the shipment. Required if items are missing weight entry - format: float - maximum: 999999.99 - example: 54 - freightType: - type: string - description: Freight type of the shipment. - enum: - - PALLET - orderDescription: - description: A short description of the Shipment Order - type: - - string - - "null" - example: WIDGETS - maxLength: 30 - shipperReference: - description: A reference to the shipment provided by the Shipper - type: - - string - - "null" - example: ABC123 - maxLength: 30 - consigneeReference: - description: A reference to the shipment provided by the Consignee - type: - - string - - "null" - example: Z30010021 - maxLength: 30 - currency: - description: The currency code associated with the Shipment. Default is USD - type: - - string - - "null" - example: USD - isMetric: - description: A flag to indicate if the measurements are metric - type: - - boolean - - "null" - default: false - items: - type: array - description: A collection of the details of each item that is associated with the Shipment - minItems: 1 - items: - $ref: "#/components/schemas/ApolloItemV1" - countryOfManufacture: - description: An unbounded array of country codes where the items originated - minItems: 1 - type: array - items: - type: - - string - - "null" - maxLength: 3 - example: US - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false - label: - type: object - required: - - format - properties: - layout: - description: A key that determines the template that is used for the label. + format: double + freightChargesAmount: + description: total freight charges associated with the shipments in the manifest + type: number + format: double + surchargesAmount: + description: total surcharges associated with the shipments in the manifest + type: number + format: double + addedChargesAmount: + description: total added charges associated with the shipments in the manifest + type: number + format: double + billedAmount: + description: total billed charges associated with the shipments in the manifest + type: number + format: double + additionalProperties: false + dailyPickupTotals: + $ref: "#/components/schemas/ApolloPickupTotalV1" + currentPickupTotals: + $ref: "#/components/schemas/ApolloPickupTotalV1" + additionalProperties: false + additionalProperties: false + manifestNumber: + description: The unique number to identify the manifest type: - string - "null" - maxLength: 40 - example: AF-GEMINI - format: - description: The output format of the document. + minLength: 1 + example: M934567890 + manifestFormat: + description: The output format of the manifest type: - string - "null" - enum: - - PDF - - PNG - - JPG - - BMP - - TIFF - - SVG - - DATA - details: - description: Additional details needed for the label. May include the custom fields that the label template supports - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false - language: - description: The language/culture that is being used for the API - type: string - maxLength: 6 - transId: - description: A transaction Id to track this API call - type: string - additionalProperties: false - ApolloOrderResponseV1: - type: object - description: Response from the Order API - required: - - response - properties: - response: - allOf: - - $ref: "#/components/schemas/ApolloLabelV1" - - type: object - required: - - shipmentNumber - - orderNumber - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: - type: string - additionalProperties: true - ApolloCancelOrderRequestV1: - description: The request used to cancel an Order - type: object - required: - - account - - orderNumber - properties: - account: - description: The unique number that identifies the Shipment - type: - - string - - "null" - example: "123456789" - maxLength: 9 - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - language: - description: The language/culture that is being used for the API - type: string - maxLength: 6 - example: en-US - additionalProperties: false - ApolloCancelOrderResponseV1: - type: object - description: The response from Order Cancel Operation - required: - - response - properties: - response: - type: object - required: - - shipmentNumber - - orderNumber - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" + minLength: 1 + example: PDF + manifestPDF: + description: The base64 string representing the byte array of the generated PDF + type: + - string + - "null" + format: byte + example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== warnings: $ref: "#/components/schemas/ApolloWarningArrayV1" message: type: string additionalProperties: false - - #/air/orders/print-label - ApolloOrderPrintLabelRequestV1: - description: The API request used to print a Label + ApolloAirShipmentCancelRequestV1: type: object required: - shipperAccountNumber - - orderNumber - - layout - - format + - shipmentNumber properties: shipperAccountNumber: $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - layout: - description: A key that determines the template that is used for the label. - type: - - string - - "null" - minLength: 1 - maxLength: 40 - example: AF-GEMINI - format: - description: The output format of the document. - type: - - string - - "null" + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + language: + description: The language/culture that is being used for the API + type: string minLength: 1 - example: PDF - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" + maxLength: 6 + example: en-US additionalProperties: false - - #/air/orders/set-date: - # ApolloOrderSetDateRequestV1: - # $ref: "#/components/schemas/ApolloPatchReplaceReqV1" - # additionalProperties: false - ApolloOrderSetDateResponseV1: - description: The response from the date change operation + ApolloAirShipmentCancelResponseV1: type: object + description: Response from the Shipment Cancel API required: - response properties: response: - type: - - object - - "null" + type: object required: - - shipmentNumber - - orderNumber - - newDate + - shipperAccountNumber + - shipmentNumber properties: + shipperAccountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" shipmentNumber: $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - newDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" warnings: $ref: "#/components/schemas/ApolloWarningArrayV1" message: type: string + additionalProperties: false - #/air/orders/search - ApolloOrderSearchRequestV1: - type: object - required: - - shipperAccountNumber - - criteriaList - properties: - shipperAccountNumber: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - criteriaList: - description: An array of search criteria - type: - - array - - "null" - minItems: 1 - maxItems: 12 - items: - type: - - object - - "null" - required: - - criteriaField - - criteriaOperator - - criteriaValue - properties: - criteriaField: - description: The field that is used for search - type: - - string - - "null" - minLength: 1 - example: SHIP_DATE - criteriaOperator: - description: The Operator used in the search - type: - - string - - "null" - minLength: 1 - example: BTWN - criteriaValue: - description: The value that is used in the search - type: - - string - - "null" - minLength: 1 - example: "8" - criteriaValue2: - description: The value that is used in the search - type: - - string - - "null" - minLength: 1 - example: 2025-07-23 - additionalProperties: false - language: - description: The language/culture used in the request - type: - - string - - "null" - example: en-US - additionalProperties: false - ApolloOrderSearchResponseV1: - description: The response provided by the Apollo Order Search API + #/air/utility/city-details + ApolloGetCityResponseV1: type: object + description: Response from the Order API required: - response properties: response: type: object required: - - orders + - cityDetails properties: - orders: + cityDetails: + description: The unbounded array representing the cities type: array minItems: 1 - maxItems: 5000 items: type: - object - "null" - required: - - shipmentNumber - - orderNumber - - consignee - - shipDate - - statusCode - - status - - description - - manifestNumber - - shipperReference - - consigneeReference - - isMetric - - items - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - consignee: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - description: The consignee associated with the Shipment - shipDate: - description: The RFC 3339 scheduled ship date. - $ref: "#/components/schemas/ApolloDateV1" - statusCode: - description: TThe code indicating the status of the Order - type: integer - format: int32 + required: + - stateProvinceCode + properties: + stateProvinceCode: + description: The State/Province to which the city belongs to + type: + - string + - "null" minLength: 1 - minimum: 1 - example: 8 - status: - description: The description of the status of the Order + example: GA + cityName: + description: The name of the city type: - string - "null" minLength: 1 - example: POSTED - description: - description: The description of the Order + example: Alpharetta + majorAirportCity: + description: The nearest city with a major airport type: - string - "null" minLength: 1 - example: Lots of stuff - manifestNumber: - description: The unique Id to identify the Manifest + example: Atlanta + tariffDestination: + description: The destination used for billing purpose type: - string - "null" minLength: 1 - example: M934567890 - shipperReference: - description: The reference provided by Shipper + example: ATL + sortCode: + description: A value which helps the Ops team to route the package type: - string - "null" minLength: 1 - example: SHIPPER REF - consigneeReference: - description: The reference provided by Consignee + example: V1 + standardService: + description: The standard service offered in this city type: - string - "null" minLength: 1 - example: CONSIGNEE REF - isMetric: - description: The flag indicating whether the measurements are metric - type: boolean - default: false - items: - type: object - required: - - totalWeight - - weightUnit - - totalPieceCount - properties: - totalWeight: - description: The total weight of the Items in the Order - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 14 - weightUnit: - description: The tunits used to calculate weight - type: - - string - - "null" - enum: - - LB - totalPieceCount: - description: The total number of Pieces in the Order - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 2 - item: - description: The unbounded array of individual items in the Order - type: array - minItems: 1 - items: - type: - - object - - "null" - required: - - count - - length - - width - - height - - weight - properties: - count: - description: The number of components in the item - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 1 - length: - description: The length of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - width: - description: The width of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - height: - description: The height of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - weight: - description: The weight of each component in the item - type: number - format: float - minimum: 1 - minLength: 1 - example: 10 - additionalProperties: false - additionalProperties: false + example: GND additionalProperties: false warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" + $ref: "#/components/schemas/ApolloWarningArrayV1" message: type: string - additionalProperties: true - - #/air/shipment - # ApolloAirShipmentSubmitRequestV1: - # $ref: "#/components/schemas/ApolloPatchReplaceReqV1" - # additionalProperties: false + additionalProperties: false - ApolloAirShipmentDataResponseV1: + ApolloPrintManifestRequestV1: + description: The API request used to print a Manifest + type: object + required: + - manifestNumber + properties: + accountNumber: + $ref: "#/components/schemas/ApolloShipperAccountNumberV1" + manifestNumber: + description: The unique Id to identify the Manifest + type: + - string + - "null" + minLength: 1 + example: M934567890 + manifestFormat: + description: The output format of the document. + type: + - string + - "null" + minLength: 1 + default: PDF + enum: + - PDF + - DATA + example: PDF + language: + description: The language/culture that is being used for the API + type: string + minLength: 1 + maxLength: 6 + default: en-US + example: en-US + additionalProperties: false + #COMMON + ApolloAmountV1: + type: + - number + - "null" + format: double + examples: + - 10.00 + ApolloChargeAmountV1: + type: object + required: + - amount + - currencyCode + properties: + amount: + type: + - string + - "null" + description: Cost associated with the charge + examples: + - "10.00" + - waived + - included + currencyCode: + description: The ISO 4217 charge currency code + type: + - string + - "null" + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD + includedInd: + type: + - string + - "null" + description: Indicates if charge is included in base rate (Y/N) + additionalProperties: false + ApolloChargeV1: + type: object + required: + - code + - amount + - currencyCode + properties: + code: + description: The code used to identify the charge for classification and categorization + type: + - string + - "null" + minLength: 1 + example: AF + description: + description: A short overview of the charge + type: + - string + - "null" + minLength: 1 + example: Air Freight + amount: + type: + - string + - "null" + description: Cost associated with the charge + examples: + - "10.00" + - waived + - included + currencyCode: + description: The ISO 4217 charge currency code + type: + - string + - "null" + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD + includedInd: + type: + - string + - "null" + description: Indicates if charge is included in base rate (Y/N) + additionalProperties: false + ApolloCountryCodeV1: + type: string + minLength: 2 + maxLength: 2 + pattern: '^[A-Z]{2}' + example: US + ApolloCustomArrayV1: + type: array + description: Unbounded array of additional key-value pair objects + minItems: 1 + items: + type: object + description: key-value pair object + properties: + key: + type: string + description: the name referencing the paired object + minLength: 1 + example: HAZMAT + value: + type: string + description: the value referencing the paired object + minLength: 1 + example: "true" + additionalProperties: false + ApolloDateV1: + type: string + format: date + pattern: "^((0[1-9]|1[0,1,2])/(0[1-9]|[12][0-9]|3[01])/(20)\\d{2})|((20)\\d{2}-(0[1-9]|1[0,1,2])-(0[1-9]|[12][0-9]|3[01]))$" + example: 2025-12-13 + ApolloDateTimeV1: + type: string + format: date-time + example: 2025-05-13 05:00:00 + ApolloDimensionV1: + type: number + format: float + minimum: 0.1 + maximum: 999.9 + examples: + - 15 + - 6.84 + ApolloWarningArrayV1: + type: + - array + description: Unbounded array containing one or more warning objects + items: + type: object + description: Warning Entity + properties: + code: + type: string + description: warning code + minLength: 1 + example: "1050 " + message: + type: string + description: warning message + minLength: 1 + example: Consignee Contact Name too long. + required: + - code + - message + additionalProperties: false + ApolloErrorResponseV1: type: object - description: Response from the Shipment API - required: - - response - properties: + description: Response object for errors + properties: response: type: object - required: - - account - - pickupDate - - shipmentCount - - pieceCount - - weight - - weightUnit - - manifest + description: Response container to store errors + properties: + errors: + type: array + description: Unbounded array containing one or more error objects + minItems: 1 + items: + type: object + description: Error entity + properties: + code: + type: string + description: error code + minLength: 1 + example: "-250002" + message: + type: string + description: error message + minLength: 1 + example: Invalid Authentication Information. + required: + - code + - message + additionalProperties: false + required: + - errors + additionalProperties: false + required: + - response + additionalProperties: false + ApolloItemV1: + type: object + required: + - itemDescription + - count + - length + - width + - height + - weight + properties: + itemDescription: + description: A short description of the item + type: + - string + - "null" + count: + description: A total number of this item + type: + - integer + - "null" + format: int32 + + minimum: 1 + maximum: 99999 + example: 10 + length: + description: Length of this item + type: number + format: float + + minimum: 1 + maximum: 999 + example: 10 + width: + description: Width of this item + type: number + format: float + + minimum: 1 + maximum: 999 + example: 10 + height: + description: Height of this item + type: number + format: float + + minimum: 1 + maximum: 999 + example: 10 + weight: + description: Total weight of these items + type: number + format: float + + minimum: 1 + maximum: 99999 + example: 10 + details: + description: The extra attributes that can be used in a label + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + ApolloLabelV1: + description: | + An object representing the shipping label. + + | **labelFormat** | **Returned Containers** | + | :--: | :-- | + | DATA | labelFormat, labelData | + | PDF, PNG | labelFormat, labelImage | + type: object + required: + - labelFormat + - shipmentNumber + - orderNumber + - charges + properties: + labelFormat: + description: The output format for the label + type: + - string + - "null" + minLength: 1 + example: PDF + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + orderNumber: + $ref: "#/components/schemas/ApolloOrderNumberV1" + charges: + description: A collection of charges associated with this Order. Conditionally required based on payer of charges. + type: object properties: - account: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - pickupDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" - shipmentCount: - description: The count of all Shipments that are submitted for processing - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 2 - pieceCount: - description: The count of all peieces in all the shipments submitted - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 2 - weight: - description: The total weight of all the shipments - type: number - format: float - minimum: 1 - minLength: 1 - example: 2 - weightUnit: - description: The unit used to measure the weight + shipperCharges: + description: A collection of charges associated with this Order mapped to the shipper type: - - string + - array - "null" - manifest: - description: The manifest data that is returned if the format chosen is data + items: + $ref: "#/components/schemas/ApolloChargeV1" + consigneeCharges: + description: A collection of charges associated with this Order mapped to the consignee + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloChargeV1" + thirdPartyCharges: + description: A collection of charges associated with this Order mapped to the third party + type: + - array + - "null" + items: + $ref: "#/components/schemas/ApolloChargeV1" + additionalProperties: false + labelData: + type: object + required: + - shipper + - consignee + - shipment + properties: + shipper: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + consignee: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + thirdParty: + $ref: "#/components/schemas/ApolloShipmentPartyV1" + shipment: type: object - required: - - manifestNumber - - manifestFormat - - shipper - - shipments properties: - manifestNumber: - description: The unique number used to identify a manifest + shipmentNumber: + $ref: "#/components/schemas/ApolloShipmentNumberV1" + serviceType: + description: The service type associated with the Order + type: + - string + - "null" + minLength: 1 + example: AM + paymentType: + description: The payment type associated with the Order + type: + - string + - "null" + minLength: 1 + example: PPD + pickupDate: + description: The RFC 3339 scheduled pickup date. + $ref: "#/components/schemas/ApolloDateV1" + readyTime: + description: The pickup ready time. + $ref: "#/components/schemas/ApolloTimeV1" + closeTime: + description: The location close time. + $ref: "#/components/schemas/ApolloTimeV1" + dropoffTime: + description: The shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + weight: + type: number + description: Total weight of the shipment. + format: float + maximum: 999999.99 + minLength: 1 + minimum: 1 + example: 10 + freightType: + type: string + description: Freight type of the shipment. + enum: + - PALLET + - LOOSE + orderDescription: + description: A short description of the Order type: - string - "null" minLength: 1 - example: M934567890 - manifestFormat: - description: The output format of the manifest + example: WIDGETS + shipperReference: + description: A reference to the Order provided by Shipper type: - string - "null" minLength: 1 - example: PDF - shipper: - $ref: "#/components/schemas/ApolloShipmentAddressV1" - shipments: - description: An array of shipment details included in the manifest + example: ABC123 + consigneeReference: + description: A reference to the Order for the Consignee + type: + - string + - "null" + minLength: 1 + example: Z30010021 + currency: + description: The currency associated with the Order + type: + - string + - "null" + minLength: 3 + maxLength: 3 + example: USD + isMetric: + description: A flag indicating whether the units used are metric + type: + - string + - "null" + items: + description: A collection of items type: - array - "null" + items: + $ref: "#/components/schemas/ApolloItemV1" + countryOfManufacture: + description: An unbounded array of country codes where the items originated + type: array + minItems: 1 items: type: - - object + - string - "null" - required: - - number - - shipmentNumber - - serviceType - - paymentType - - weight - - currency - - consignee - properties: - number: - description: The index of the shipment - type: integer - format: int32 - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - serviceType: - description: The service type used in the Shipment - type: - - string - - "null" - minLength: 1 - example: AM - paymentType: - description: The Payment type used in the shipment - type: - - string - - "null" - minLength: 1 - example: PPD - weight: - description: The total weight of the shipment - type: number - format: float - minLength: 1 - minimum: 1 - example: 10 - orderDescription: - description: A short description of the Order - type: - - string - - "null" - minLength: 1 - example: WIDGETS - currency: - description: The Acurrency used in the shipment - type: - - string - - "null" - minLength: 3 - maxLength: 3 - example: USD - shipperReference: - description: The reference provided by the shipper for the shipment - type: - - string - - "null" - minLength: 1 - example: ABC123 - consigneeReference: - description: The reference provided by the consignee for the shipment - type: - - string - - "null" - minLength: 1 - example: Z30010021 - consignee: - $ref: "#/components/schemas/ApolloShipmentAddressV1" - additionalProperties: false - summary: - type: object - required: - - services - - serviceTotal - - dailyPickupTotals - - currentPickupTotals - properties: - services: - description: The services used by the shipments and associated details - type: - - array - - "null" - items: - type: - - object - - "null" - required: - - shipmentCount - - itemCount - - totalWeight - - freightChargesAmount - - surchargesAmount - - addedChargesAmount - - billedAmount - - serviceCode - - serviceName - properties: - shipmentCount: - description: number of shipments using this service associated with this manifest - type: integer - format: int32 - minLength: 1 - minimum: 1 - example: 3 - itemCount: - description: The total number items in those shipments - type: integer - format: int32 - minLength: 1 - minimum: 1 - example: 3 - totalWeight: - description: The Atotal weight of those items - type: number - format: double - minLength: 1 - minimum: 1 - example: 3 - freightChargesAmount: - description: The total charges for this service - $ref: "#/components/schemas/ApolloAmountV1" - surchargesAmount: - description: The total surcharges for this service associated with this manifest - $ref: "#/components/schemas/ApolloAmountV1" - addedChargesAmount: - description: The total added charges for this service associated with this manifest - $ref: "#/components/schemas/ApolloAmountV1" - billedAmount: - description: Total Billed amount for this service - $ref: "#/components/schemas/ApolloAmountV1" - serviceCode: - description: The code for this service - type: - - string - - "null" - minLength: 1 - example: "01" - serviceName: - description: The name of the service - type: - - string - - "null" - minLength: 1 - example: "Next Day Air Early AM" - additionalProperties: false - serviceTotal: - type: object - description: The total for all services - required: - - shipmentCount - - itemCount - - totalWeight - - freightChargesAmount - - surchargesAmount - - addedChargesAmount - - billedAmount - properties: - shipmentCount: - description: The total number of shipments - type: integer - format: int32 - itemCount: - description: The total count of shipments - type: integer - format: int32 - totalWeight: - description: The total weight of shipments - type: number - format: double - freightChargesAmount: - description: total freight charges associated with the shipments in the manifest - type: number - format: double - surchargesAmount: - description: total surcharges associated with the shipments in the manifest - type: number - format: double - addedChargesAmount: - description: total added charges associated with the shipments in the manifest - type: number - format: double - billedAmount: - description: total billed charges associated with the shipments in the manifest - type: number - format: double - additionalProperties: false - dailyPickupTotals: - $ref: "#/components/schemas/ApolloPickupTotalV1" - currentPickupTotals: - $ref: "#/components/schemas/ApolloPickupTotalV1" + minLength: 1 + example: US + details: + description: The extra attributes that can be used in a label + $ref: "#/components/schemas/ApolloCustomArrayV1" + rates: + description: The cost associated with the Order to be printed in the label + type: object + properties: + amount: + $ref: "#/components/schemas/ApolloAmountV1" + currencyCode: + type: + - string + - "null" + description: The ISO 4217 currency code + minLength: 3 + maxLength: 3 + pattern: ^[A-Z]{3} + example: USD additionalProperties: false - additionalProperties: false - manifestNumber: - description: The unique number to identify the manifest + sortCode: + description: The routing value to help the Ops Team + type: + - string + - "null" + minLength: 1 + example: U-BOS + gateway: + description: The airport gateway for routing + type: + - string + - "null" + minLength: 1 + example: "2" + count: + description: The total number of items in the order + type: integer + format: int32 + + minimum: 1 + example: 2 + labelService: + description: The service entry used by the Ops Team + type: + - string + - "null" + minLength: 1 + example: ND + serviceDesc: + description: The description of the service + type: + - string + - "null" + minLength: 1 + example: UPS Next Day Air Freight - NGS + additionalProperties: false + additionalProperties: false + labelImage: + description: The byte array of the generated PDF represented as base64 string + type: + - string + - "null" + format: byte + example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + additionalProperties: false + ApolloOrderNumberV1: + description: The Unique number used to identify the order + type: string + pattern: "^[0-9]{13}$" + example: "9100010270001" + ApolloPartyV1: + type: object + description: Party information (shipper, consignee, or third party). + + + + properties: + company: + type: + - string + - "null" + maxLength : 35 + description: Name of the company. + example: Philip + account: + type: + - string + - "null" + maxLength : 9 + minLength : 6 + description: Account number associated with the party. + example: "987654321" + address1: + type: string + maxLength: 40 + minLength: 0 + description: Primary address line. + example: 12380 MORRIS RD + address2: + type: string + maxLength: 40 + minLength: 0 + description: Secondary address line. + example: Mailroom + address3: + type: string + maxLength: 40 + minLength: 0 + description: Last address line. + example: Floor 1 + city: + type: string + maxLength: 30 + minLength: 0 + description: City of the party. + example: Alpharetta + state: + type: string + description: The state code is required for country codes US or CA + minLength: 2 + maxLength: 2 + pattern: '^[A-Z]{2}' + example: GA + postalCode: + type: string + maxLength: 10 + minLength: 0 + description: Postal code of the party. + example: "30005" + countryCode: + description: The ISO 3166 country or territory code. + $ref: "#/components/schemas/ApolloCountryCodeV1" + serviceCenterCode: + type: string + maxLength: 5 + minLength: 0 + description: Service center code. + examples: + - SDF + - EWR + - ATL + partyCode: + type: string + maxLength: 40 + minLength: 0 + description: Party code. + example: CID-987654321 + contactName: + type: + - "string" + - "null" + maxLength: 40 + minLength: 0 + description: Name of the contact person. + example: Michael + contactPhone: + type: + - "string" + - "null" + maxLength: 40 + minLength: 0 + description: Phone number of the contact person. + example: "999999999" + contactEmail: + type: + - "string" + - "null" + maxLength: 40 + minLength: 0 + description: Email address of the contact person. + pattern: '^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$' + example: test@gmail.com + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + additionalProperties: false + ApolloPickupTotalV1: + type: object + required: + - shipmentCount + - itemCount + - totalWeight + - pieceCount + properties: + shipmentCount: + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 10 + itemCount: + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 10 + pieceCount: + type: integer + format: int32 + minimum: 1 + minLength: 1 + example: 10 + totalWeight: + type: number + format: double + minimum: 1 + minLength: 1 + example: 10 + additionalProperties: false + ApolloShipmentNumberV1: + type: + - string + - "null" + description: Unique identifier for the shipment. + minLength: 1 + maxLength: 10 + examples: + - "9100010271" + ApolloShipmentPartyV1: + allOf: + - $ref: "#/components/schemas/ApolloShipmentAddressV1" + - type: object + description: Additional shipment party specific fields. All are optional. + properties: + account: type: - string - "null" - minLength: 1 - example: M934567890 - manifestFormat: - description: The output format of the manifest + maxLength : 9 + minLength : 6 + description: The unique UPS Freight Account Number associated with the Party. It's required when the party is the Shipper or Payor + example: 5503YY + serviceCenterCode: type: - string - "null" - minLength: 1 - example: PDF - manifestPDF: - description: The base64 string representing the byte array of the generated PDF + maxLength : 5 + description: The service center that is associated with the Party. + example: SDF + contactName: type: - string - "null" - format: byte - example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: - type: string - additionalProperties: false - ApolloAirShipmentCancelRequestV1: + maxLength : 40 + description: The name of the person who can handle the communications related to the Shipment + example: John Doe + contactPhone: + type: + - string + - "null" + maxLength : 25 + description: The phone number of the person who can handle the communications related to the Shipment + example: 678-123-4567 + contactEmail: + type: + - string + - "null" + minLength: 1 + maxLength : 70 + description: The email of the person who can handle the communications related to the Shipment + example: john.doe@acme.com + details: + description: Any additional information related to the party in the format of key value pair + $ref: "#/components/schemas/ApolloCustomArrayV1" + unevaluatedProperties: false + ApolloShipmentAddressV1: + type: object + discriminator: + propertyName: operationId + mapping: + orderCreate: '#/components/schemas/ApolloOrderResponseV1' + orderSearch: '#/components/schemas/ApolloOrderSearchResponseV1' + printLabel: '#/components/schemas/ApolloLabelV1' + submitAirShipment: '#/components/schemas/ApolloAirShipmentDataResponseV1' + required: + - address1 + - city + - postalCode + - countryCode + properties: + operationId: + description: A string value to track this operation + type: + - string + - "null" + enum: + - orderCreate + - orderCancel + - orderSetDate + - orderSearch + - printLabel + - submitAirShipment + - cancelAirShipment + - printAirManifest + - airFreightRating + - getCity + partyCode: + type: + - string + - "null" + maxLength : 32 + description: The hashcode generated using the a Party's details, primarily used to avoid duplicates + example: CID-987654321 + company: + type: + - string + - "null" + maxLength : 40 + description: The name of the company associated with the Shipment/Party + example: Ship To Philip + address1: + type: + - string + - "null" + maxLength : 40 + description: The line 1 of the address associated with the Party + example: 45678 MAIN ST + address2: + type: + - string + - "null" + description: The line 2 of the address associated with the Party + example: Suite 320 + address3: + type: + - string + - "null" + maxLength : 40 + description: The line 3 of the address associated with the Party + example: Floor 3 + city: + type: + - string + - "null" + maxLength : 40 + description: The address city associated with the Party + example: Newark + state: + type: + - string + - "null" + minLength: 2 + maxLength : 4 + pattern: ^[A-Z]{2} + description: The ISO 3166-2 state code associated with the Party + example: NJ + postalCode: + type: + - string + - "null" + maxLength : 15 + description: The postal code of the address associated with the Party + example: "07102" + countryCode: + type: + - string + - "null" + minLength: 2 + maxLength : 4 + description: The ISO 3166 country or territory code associated with the Party + pattern: ^[A-Z]{2} + example: US + ApolloShipperAccountNumberV1: + description: The UPS Freight Account Number that identifies the Shipper + type: + - string + - "null" + minLength: 1 + maxLength: 9 + example: "123456789" + ApolloTimeV1: + type: string + format: time + pattern: '^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$' + example: 09:00:00 + ApolloWeightV1: + type: number + format: decimal + multipleOf: 0.01 + ApolloPatchReplaceReqV1: + type: array + description: The unbounded list of objects to change with their values + minItems: 1 + items: + type: object + required: + - op + - path + + properties: + op: + type: + - string + - "null" + enum: + - replace + path: + type: + - string + - "null" + description: the field whose value is to be changed + example: /newDate + value: + type: + - string + - "null" + description: new value to insert into the defined field + example: 2025-07-24 + additionalProperties: false + #Common Schemas for newly added APIs + + Charges: + type: object + description: Individual charge information. + properties: + role: + type: string + description: Party responsible for the charge (e.g., SHPR for shipper) + example: "SHPR" + code: + type: string + description: Charge type code. + example: "FAS" + description: + type: string + description: Human-readable description of the charge + example: "Delivery to Door - Included" + amount: + type: number + format: double + description: Amount of the charge. + example: 359.16 + currencyCode: + type: string + description: ISO 4217 three-letter currency code + example: "USD" + includedInd: + type: string + description: Indicates if charge is included in base rate (Y/N) + example: "N" + + + + + + + + #/air/ship + ApolloAirShipRequestV1: + type: object + required: [shipper, consignee, shipment] + properties: + shipper: + $ref: '#/components/schemas/PartyDetails' + consignee: + $ref: '#/components/schemas/PartyDetails' + thirdParty: + + + + type: [object, "null"] + description: ThirdParty details for the shipment. + oneOf: + - $ref: '#/components/schemas/PartyDetailsV1' + - type: "null" + shipment: + $ref: '#/components/schemas/ShipmentDetail' + label: + type: [object, "null"] + description: Label formatting options including layout and format (e.g., PDF, ZPL, SVG). + oneOf: + - $ref: '#/components/schemas/LabelRequest' + - type: "null" + language: + type: string + description: Language preference for the response. + example: "en" + transactionId: + type: string + description: Unique transaction ID for debugging and tracking. + example: "txn-001" + PartyDetails: + type: object + required: [account, address1, contactName, contactPhone, contactEmail, company, city, countryCode] + properties: + account: + type: + - string + - "null" + maxLength : 9 + minLength: 6 + description: UPS Freight Account Number associated with the party is required when the address is not provided. + example: "123456789" + address1: + type: string + description: The primary address line. + minLength: 1 + maxLength: 40 + example: "123 Main St" + city: + type: string + description: City of the address. + minLength: 1 + maxLength: 30 + example: "New York" + state: + type: string + description: The state code is required for country codes US or CA. + maxLength: 5 + example: "NY" + postalCode: + type: string + description: Postal or ZIP code. + maxLength: 10 + example: "10001" + countryCode: + type: string + description: Two-letter country code (e.g., US, CA, GB). + minLength: 2 + maxLength: 2 + example: "US" + serviceCenterCode: + type: string + description: ServiceCenterCode of the party. + maxLength: 5 + example: "NYC" + partyCode: + type: string + description: PartyCode of the party. + maxLength: 40 + example: "SHIP123" + company: + type: string + description: CompanyName - The name of the company. + minLength: 1 + maxLength: 35 + example: "Shipper Inc" + contactName: + type: string + description: ContactName - The name of the contact person. + minLength: 1 + maxLength: 40 + example: "John Doe" + contactPhone: + type: string + description: ContactPhone - The phone number of the contact person. + minLength: 1 + maxLength: 25 + example: "+1-555-1234" + contactEmail: + type: string + description: Email - The email address of the contact person. + minLength: 1 + maxLength: 40 + pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ + example: "john.doe@shipper.com" + partySectionDetails: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + PartyDetailsV1: + type: object + required: [account] + properties: + account: + type: + - string + - "null" + maxLength : 9 + minLength: 6 + description: UPS Freight Account Number associated with the party is required when the address is not provided. + example: "123456789" + address1: + type: string + description: The primary address line. + minLength: 1 + maxLength: 40 + example: "123 Main St" + city: + type: string + description: City of the address. + minLength: 1 + maxLength: 30 + example: "New York" + state: + type: string + description: The state code is required for country codes US or CA. + maxLength: 5 + example: "NY" + postalCode: + type: string + description: Postal or ZIP code. + maxLength: 10 + example: "10001" + countryCode: + type: string + description: Two-letter country code (e.g., US, CA, GB). + minLength: 2 + maxLength: 2 + example: "US" + serviceCenterCode: + type: string + description: ServiceCenterCode of the party. + maxLength: 5 + example: "NYC" + partyCode: + type: string + description: PartyCode of the party. + maxLength: 40 + example: "SHIP123" + company: + type: string + description: CompanyName - The name of the company. + minLength: 1 + maxLength: 35 + example: "Shipper Inc" + contactName: + type: string + description: ContactName - The name of the contact person. + minLength: 1 + maxLength: 40 + example: "John Doe" + contactPhone: + type: string + description: ContactPhone - The phone number of the contact person. + minLength: 1 + maxLength: 25 + example: "+1-555-1234" + contactEmail: + type: string + description: Email - The email address of the contact person. + minLength: 1 + maxLength: 40 + pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ + example: "john.doe@shipper.com" + partySectionDetails: + + + + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + ShipmentDetail: + type: object + required: [serviceType, paymentType, pickupDate, items, freightType] + properties: + shipmentNumber: + type: string + description: Shipment number associated with the request. + example: "SHIP0001" + serviceType: + type: string + description: Type of the service requested (e.g., AM, AMG, D2, D2G, DF, DFG, CA, EC, CX). + enum: [AM, AMG, D2, D2G, DF, DFG, CA, EC, CX] + example: "AM" + paymentType: + type: string + description: Payment method used for the shipment (e.g., PPD, COL, THD). + enum: [PPD, COL, THD] + example: "PPD" + pickupDate: + type: string + format: date + description: Scheduled pickup date in YYYY-MM-DD format. + pattern: ^\d{4}-\d{2}-\d{2}$ + example: "2025-08-11" + readyTime: + type: string + description: Time when the shipment will be ready for pickup (HH:MM:SS in 24-hour format). + pattern: ^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$ + example: "09:00:00" + closeTime: + type: string + description: Time when the shipment location will close (HH:MM:SS in 24-hour format). + pattern: ^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$ + example: "17:00:00" + dropoffTime: + type: string + description: Time when the shipment will be dropped off (HH:MM:SS in 24-hour format). + pattern: ^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$ + example: "16:00:00" + weight: + type: number + format: decimal + description: Total weight of the shipment. + minimum: 0.1 + maximum: 999.9 + example: 25.5 + freightType: + type: string + description: FreightType - This is freight type of the shipment piece. Possible values PALLET, LOOSE. + enum: [PALLET, LOOSE] + example: "PALLET" + isMetric: + type: boolean + description: Boolean value which indicates whether the shipment uses metric. + example: true + orderDescription: + type: string + description: Description of the shipment. + example: "Electronics shipment" + shipperReference: + type: string + description: Reference number provided by the shipper. + example: "REF123" + consigneeReference: + type: string + description: Reference number provided by the consignee. + example: "CREF456" + currency: + type: string + description: Currency code (e.g., USD, EUR). + minLength: 3 + maxLength: 3 + example: "USD" + requestPickup: + type: boolean + description: Boolean value which indicates whether a pickup request is included. + example: true + requestBoL: + type: boolean + description: Boolean value which Indicates whether a Bill of Lading (BoL) is requested. + example: false + countryOfManufacture: + type: array + items: + type: string + minLength: 2 + maxLength: 2 + description: List of countries where the goods were manufactured. + example: ["US"] + items: + type: array + minItems: 1 + maxItems: 100 + items: + $ref: '#/components/schemas/Item' + details: + description: Additional details about the party as key-value pairs. + $ref: "#/components/schemas/ApolloCustomArrayV1" + Item: + type: object + required: [count, length, width, height, weight] + properties: + description: + type: string + description: The description of the item. + maxLength: 50 + example: "Laptop" + count: + type: integer + description: Number of identical items in the shipment. + minimum: 1 + maximum: 99999 + example: 10 + length: + type: number + format: decimal + description: Length of the shipment item in centimeters. + minimum: 0 + maximum: 999.9 + example: 38.5 + width: + type: number + format: decimal + description: Width of the shipment item in centimeters. + minimum: 0 + maximum: 999.9 + example: 25.0 + height: + type: number + format: decimal + description: Height of the shipment item in centimeters. + minimum: 0.1 + maximum: 999.9 + example: 2.5 + weight: + type: number + format: decimal + description: Weight of the shipment item in kilograms. + minimum: 0 + maximum: 99999 + example: 2.0 + details: + $ref: "#/components/schemas/ApolloCustomArrayV1" + LabelRequest: + type: object + properties: + layout: + type: string + description: The layout type for the label (e.g., AF-GEMINI, AF-UFH). + example: "AF-GEMINI" + format: + type: string + description: The output format for the label (e.g., PDF, ZPL, SVG). + example: "PDF" + details: + type: object + additionalProperties: + type: string + description: A list of label detail fields and values. + example: + Model_Number: "X" + Model_Year: "2023" + Shipper_ReferenceNo: "SHP2401-A3MC220" + ApolloAirShipResponseV1: + type: object + required: + - response + properties: + response: + type: object + shipmentNumber: + type: string + description: The shipment number associated with the response. + example: "SHIP0001" + prqNumber: + type: string + description: The PRQ details associated with the shipment. + example: "PRQ123456" + prqStatus: + type: string + description: The shipment status. + example: "CONFIRMED" + originServiceCenter: + type: string + description: The origin service center code. + example: "NYC" + destinationServiceCenter: + type: string + description: The destination service center code. + example: "SFO" + paymentType: + type: string + description: The payment type for the shipment. + example: "PPD" + rates: + type: array + items: + $ref: '#/components/schemas/RateDetail' + airWaybillDocument: + type: string + description: Base64-encoded air waybill document. + format: byte + example: "SGVsbG8gd29ybGQhIQ==" + label: + $ref: '#/components/schemas/LabelResponse' + RateDetail: type: object - required: - - shipperAccountNumber - - shipmentNumber properties: - shipperAccountNumber: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - language: - description: The language/culture that is being used for the API + serviceType: type: string - minLength: 1 - maxLength: 6 - example: en-US - additionalProperties: false - ApolloAirShipmentCancelResponseV1: + description: The type of service. + example: "AM" + guaranteedDelivery: + type: boolean + description: Indicates if delivery is guaranteed. + example: true + deliveryTime: + type: string + description: The estimated delivery time. + example: "2025-08-12T10:00:00Z" + holdAtAirportTime: + type: string + description: The hold at airport time. + example: "2025-08-12T12:00:00Z" + totalCharge: + + + description: Total charge for the shipment. + $ref: "#/components/schemas/ApolloChargeAmountV1" + currency: + type: string + description: The currency type. + example: "USD" + billableWeight: + type: number + format: decimal + description: The billable weight. + example: 30.0 + weightUnit: + type: string + description: The Weight unit used. + example: "KG" + dimensionalWeight: + type: number + format: decimal + description: The dimensional weight. + example: 28.0 + minimumBillableWeightApplied: + type: boolean + description: Indicates if the minimum billable weight was applied. + example: false + contractRate: + type: boolean + description: Indicates if the contract rate applies. + example: false + charges: + type: array + items: + $ref: '#/components/schemas/Charges' + LabelResponse: type: object - description: Response from the Shipment Cancel API - required: - - response - properties: - response: - type: object - required: - - shipperAccountNumber - - shipmentNumber - properties: - shipperAccountNumber: - $ref: "#/components/schemas/ApolloShipperAccountNumberV1" - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: - type: string - additionalProperties: false - - #/air/utility/city-details - ApolloGetCityResponseV1: + properties: + format: + type: string + description: The format of the label. + example: "PDF" + layout: + type: string + description: The layout of the label. + example: "4x6" + + + + + image: + type: string + format: byte + description: The label in PDF format (Base64 encoded). + example: "Base64EncodedPDF" + + + + ApolloUtilityAirportDetailResponseV1: type: object - description: Response from the Order API - required: - - response - properties: + description: Response containing a collection of airport details. + properties: response: type: object - required: - - cityDetails + description: Response wrapper object. properties: - cityDetails: - description: The unbounded array representing the cities + airportDetails: type: array - minItems: 1 + description: List of airport details. items: - type: - - object - - "null" - required: - - stateProvinceCode - properties: - stateProvinceCode: - description: The State/Province to which the city belongs to - type: - - string - - "null" - minLength: 1 - example: GA - cityName: - description: The name of the city - type: - - string - - "null" - minLength: 1 - example: Alpharetta - majorAirportCity: - description: The nearest city with a major airport - type: - - string - - "null" - minLength: 1 - example: Atlanta - tariffDestination: - description: The destination used for billing purpose - type: - - string - - "null" - minLength: 1 - example: ATL - sortCode: - description: A value which helps the Ops team to route the package - type: - - string - - "null" - minLength: 1 - example: V1 - standardService: - description: The standard service offered in this city - type: - - string - - "null" - minLength: 1 - example: GND - additionalProperties: false - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: - type: string - additionalProperties: false - #COMMON - ApolloAmountV1: - type: - - number - - "null" - format: double - examples: - - 10.00 - ApolloChargeAmountV1: + $ref: "#/components/schemas/ApolloAirportResponseDetailsV1" + required: + - airportDetails + required: + - response + + ApolloAirportResponseDetailsV1: + type: object + properties: + city: + type: string + description: City where the airport is located. + example: "New York" + airportCode: + type: string + description: Unique code identifying the airport. + example: "JFK" + postalCode: + type: string + description: Postal code associated with the airport's location. + example: "11430" + stateProvince: + type: string + description: State or province of the airport's location. + example: "NY" + + CountryCodeResponseV1: + type: object + properties: + countries: + type: array + description: List of countries + items: + $ref: "#/components/schemas/CountryCodeV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + CountryCodeV1: + type: object + properties: + countryCode: + type: string + description: ISO 3166-1 alpha-2 country code + countryName: + type: string + description: Name of the country + + PaymentTermInfoV1: + type: object + properties: + code: + type: string + description: Payment type code + type: + type: string + description: Type of the payment term + description: + type: string + description: Description of the payment term + incoTermCode: + type: string + description: Incoterm code + movementTypeCode: + type: string + description: Movement type code + serviceGroupName: + type: string + description: Name of the service group + serviceLine: + type: string + description: Service line code + + PaymentTypeResponseV1: type: object - required: - - amount - - currencyCode properties: - amount: - type: - - string - - "null" - description: Cost associated with the charge - examples: - - "10.00" - - waived - - included - currencyCode: - description: The ISO 4217 charge currency code - type: - - string - - "null" - minLength: 3 - maxLength: 3 - pattern: ^[A-Z]{3} - example: USD - includedInd: - type: - - string - - "null" - additionalProperties: false - ApolloChargeV1: + shipper: + $ref: "#/components/schemas/PaymentTermInfoV1" + consignee: + $ref: "#/components/schemas/PaymentTermInfoV1" + thirdParty: + $ref: "#/components/schemas/PaymentTermInfoV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + + CurrenciesResponseV1: type: object - required: - - code - - amount - - currencyCode properties: - code: - description: The code used to identify the charge for classification and categorization - type: - - string - - "null" - minLength: 1 - example: AF - description: - description: A short overview of the charge - type: - - string - - "null" - minLength: 1 - example: Air Freight - amount: - type: - - string - - "null" - description: Cost associated with the charge - examples: - - "10.00" - - waived - - included + currencies: + type: array + description: List of currencies + items: + $ref: "#/components/schemas/CurrencyDataV1" + warnings: + $ref: "#/components/schemas/ApolloWarningArrayV1" + message: + type: string + + CurrencyDataV1: + type: object + properties: currencyCode: - description: The ISO 4217 charge currency code - type: - - string - - "null" - minLength: 3 - maxLength: 3 - pattern: ^[A-Z]{3} - example: USD - includedInd: - type: - - string - - "null" - additionalProperties: false - ApolloCountryCodeV1: - type: string - minLength: 2 - maxLength: 2 - pattern: '^[A-Z]{2}' - example: US - ApolloCustomArrayV1: - type: array - description: Unbounded array of additional key-value pair objects - minItems: 1 - items: - type: object - description: key-value pair object - properties: - key: - type: string - description: the name referencing the paired object - minLength: 1 - example: HAZMAT - value: - type: string - description: the value referencing the paired object - minLength: 1 - example: "true" - additionalProperties: false - ApolloDateV1: - type: string - format: date - pattern: "^((0[1-9]|1[0,1,2])/(0[1-9]|[12][0-9]|3[01])/(20)\\d{2})|((20)\\d{2}-(0[1-9]|1[0,1,2])-(0[1-9]|[12][0-9]|3[01]))$" - example: 2025-12-13 - ApolloDateTimeV1: - type: string - format: date-time - example: 2025-05-13 05:00:00 - ApolloDimensionV1: - type: number - format: float - minimum: 0.1 - maximum: 999.9 - examples: - - 15 - - 6.84 - ApolloWarningArrayV1: - type: - - array - description: Unbounded array containing one or more warning objects - items: - type: object - description: Warning Entity - properties: - code: - type: string - description: warning code - minLength: 1 - example: "1050 " - message: - type: string - description: warning message - minLength: 1 - example: Consignee Contact Name too long. - required: - - code - - message - additionalProperties: false - ApolloErrorResponseV1: + type: string + description: Currency code + currencyName: + type: string + description: Currency name + currencySymbol: + type: string + description: Currency symbol + + #/utility/servicetypes/search + ServiceTypeSearchResponseV1: type: object - description: Response object for errors + description: Response containing service types. properties: response: type: object - description: Response container to store errors - properties: - errors: + description: Response containing a list of serviceTypes. + properties: + serviceTypes: type: array - description: Unbounded array containing one or more error objects - minItems: 1 - items: - type: object - description: Error entity - properties: - code: - type: string - description: error code - minLength: 1 - example: "250002" - message: - type: string - description: error message - minLength: 1 - example: Invalid Authentication Information. - required: - - code - - message - additionalProperties: false - required: - - errors - additionalProperties: false - required: + description: List of available service types. + items: + $ref: "#/components/schemas/ServiceTypeInfo" + required: + - serviceTypes + required: - response - additionalProperties: false - ApolloItemV1: + + ServiceTypeInfo: + type: object + description: Service type information. + properties: + code: + type: string + description: Code for the service type. + example: "AIR" + description: + type: string + description: Description of the service type. + example: "Air Freight" + required: + - code + - description + #Create Quote API Schemas + ApolloQuoteDetailRequestV1: + type: object + required: [requestType, quoteData, routing, shipmentDetails, shipmentPartyDetail] + properties: + requestType: + type: string + description: The type of quote request (i.e, Air, Ocean). + example: "Air" + quoteData: + $ref: "#/components/schemas/QuoteData" + routing: + $ref: "#/components/schemas/Routing" + shipmentDetails: + $ref: "#/components/schemas/ShipmentDetails" + shipmentPartyDetail: + type: array + description: List of parties involved in the shipment (e.g., shipper, consignee, third party). + items: + $ref: "#/components/schemas/ShipmentPartyDetail" + + + QuoteData: + type: object + required: [serviceType, serviceLine, currencyCode, movementTypeCode, incoTermType, paymentTerm] + properties: + serviceType: + type: string + description: The type of service (e.g., DF, AM). + minLength: 2 + maxLength: 5 + example: "DF" + serviceLine: + type: string + description: The service line. + minLength: 2 + maxLength: 10 + example: "Air" + currencyCode: + type: string + description: ISO 4217 currency code. + pattern: "^[A-Z]{3}$" + minLength: 3 + maxLength: 3 + example: "USD" + movementTypeCode: + type: string + description: Code representing the movement type (e.g., DTD). + minLength: 2 + maxLength: 10 + example: "DTD" + incoTermType: + type: string + description: Incoterm type for the shipment (e.g., EXW, DAP). + minLength: 2 + maxLength: 10 + example: "EXW" + importCustomsBrokerageFee: + type: string + description: Indicates if import customs brokerage fee applies ("Y" or "N"). + pattern: "^[YN]?$" + minLength: 0 + maxLength: 1 + example: "" + exportCustomsBrokerageFee: + type: string + description: Indicates if export customs brokerage fee applies ("Y" or "N"). + pattern: "^[YN]?$" + minLength: 0 + maxLength: 1 + example: "" + paymentTerm: + $ref: "#/components/schemas/PaymentTerm" + + + PaymentTerm: type: object + properties: + type: + type: string + description: The type of payment term (e.g., Shipper, Consignee, ThridParty). + oneOf: + - title: Shipper + enum : [SHPR] + - title: Consignee + enum : [CONS] + - title: Third party + enum : [THRD] + code: + type: string + description: The code representing the payment term. + oneOf: + - title: Prepaid + enum : [PPD] + - title: Collect + enum : [COL] + - title: Third party + enum : [OTH/CON] required: - - itemDescription - - count - - length - - width - - height - - weight + - type + - code + + Routing: + type: object properties: - itemDescription: - description: A short description of the item - type: - - string - - "null" - count: - description: A total number of this item - type: - - integer - - "null" - format: int32 + origin: + $ref: "#/components/schemas/PortDetail" + destination: + $ref: "#/components/schemas/PortDetail" + specialHandlings: + type: array + items: + $ref: "#/components/schemas/SpecialHandling" + + PortDetail: + type: object + description: Code of the port + properties: + portCode: + type: string + example: "USATL" + + SpecialHandling: + type: object + properties: + type: + type: string + description: Type of special handling + example: "Temperature" + message: + type: string + example: "Keep below 8C" + temperatureControl: + type: string + description: Type of temperature control (e.g., Passive, Active). + example: "Passive" + + ShipmentDetails: + type: object + properties: + insuredValueCurrency: + type: string + description: Currency code for insured value. + pattern: "^[A-Z]{3}$" + minLength: 0 + maxLength: 3 + example: "USD" + insuredValue: + type: number + description: Insured value of the shipment. + example: 0 + customsValueCurrency: + type: string + description: Currency code for customs value. + pattern: "^[A-Z]{3}$" + minLength: 0 + maxLength: 3 + example: "USD" + customsValue: + type: number + description: Customs value of the shipment. + example: 0 + commodityName: + type: string + description: Description of the commodity being shipped. + minLength: 1 + maxLength: 40 + example: "Book" + cargoItems: + type: array + description: List of cargo items in the shipment. + items: + $ref: "#/components/schemas/CargoItem" + isHazmat: + type: boolean + description: Indicates if the shipment contains hazardous materials. + example: true + isReefer: + type: boolean + description: Indicates if the shipment requires refrigeration. + example: true + isLithium: + type: boolean + description: Indicates if the shipment contains lithium batteries. + example: true + isRestricted: + type: boolean + description: Indicates if the shipment contains restricted items. + example: true + isStackable: + type: string + description: Indicates if the cargo is stackable ("Y" or "N"), It is required for LCL. + pattern: "^[YN]$" + minLength: 1 + maxLength: 1 + example: "N" + isForkliftable: + type: string + description: Indicates if the cargo is forkliftable ("Y" or "N"), It is required for LCL. + pattern: "^[YN]$" + minLength: 1 + maxLength: 1 + example: "N" + isTiltable: + type: string + description: Indicates if the cargo is tiltable ("Y" or "N"), It is required for LCL. + pattern: "^[YN]$" minLength: 1 + maxLength: 1 + example: "N" + + CargoItem: + type: object + required: [quantity, weight, dimensions] + properties: + quantity: + type: integer + description: Number of items in the cargo. minimum: 1 - example: 10 + example: 1 + packageType: + type: string + description: Type of package (e.g., Box, Pallet), It is required for LCL. + minLength: 0 + maxLength: 20 + example: "Loose/Boxes" + packageTypeCode: + type: string + description: Code for the package type, It is required for LCL. + minLength: 1 + example: "PLT" + weight: + $ref: "#/components/schemas/WeightDetail" + dimensions: + $ref: "#/components/schemas/Dimensions" + fclCargoItems: + type: array + description: List of FCL cargo items (if applicable). + items: + $ref: "#/components/schemas/FclCargoItem" + + WeightDetail: + type: object + properties: + weight: + type: number + example: 5 + unitOfMeasurement: + type: string + example: "LB" + + Dimensions: + type: object + properties: length: - description: Length of this item type: number - format: float - minLength: 1 - minimum: 1 - example: 10 + example: 3 width: - description: Width of this item type: number - format: float - minLength: 1 - minimum: 1 - example: 10 + example: 8 height: - description: Height of this item type: number - format: float + example: 3 + unitOfMeasurement: + type: string + example: "in" + + FclCargoItem: + type: object + properties: + equipmentCode: + type: string + description: Equipment code for the container (e.g., 40HC). + example: "20DV" + noOfContainers: + type: integer + description: Number of containers for this equipment type. + example: 1 + + ShipmentPartyDetail: + type: object + properties: + type: + type: string + description: Type of party (e.g., SHPR, CONS, THRD). + minLength: 2 + maxLength: 5 + example: "SHPR" + accountNumber: + type: + - "string" + - "null" + description: Account number for the party. + minLength: 6 + maxLength: 20 + example: "123456789" + contactDetail: + $ref: "#/components/schemas/ContactDetail" + address: + $ref: "#/components/schemas/PartyAddress" + + ContactDetail: + type: object + properties: + name: + type: string + description: Name of the contact person. + example: "Zeus" + emailAddress: + type: string + description: Email address of the contact person. + format: email + pattern: "^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+$" + example: "test1@ups.com" + faxNumber: + type: string + description: Fax number of the contact person. + phoneNumber: + type: string + description: Phone number of the contact person. + example: "+1-8888888888" + referenceNumber: + type: string + description: Reference number for the contact. + example: "REF123" + + + PartyAddress: + type: object + properties: + companyName1: + type: string + description: Primary company name. minLength: 1 - minimum: 1 - example: 10 - weight: - description: Total weight of these items - type: number - format: float + maxLength: 35 + example: "Walmart" + companyName2: + type: string + description: Secondary company name. + minLength: 0 + maxLength: 35 + addressLine1: + type: string + description: First line of the address. minLength: 1 - minimum: 1 - example: 10 - additionalProperties: false - ApolloLabelV1: - description: | - An object representing the shipping label. - - | **labelFormat** | **Returned Containers** | - | :--: | :-- | - | DATA | labelFormat, labelData | - | PDF, PNG | labelFormat, labelImage | + maxLength: 35 + example: "702 SW 8th St" + addressLine2: + type: string + description: Second line of the address. + minLength: 0 + maxLength: 35 + example: "Bentonville" + addressLine3: + type: string + description: Third line of the address. + minLength: 0 + maxLength: 35 + city: + type: string + description: City of the address. + minLength: 1 + maxLength: 30 + example: "LOS ANGELES" + stateCode: + type: string + description: State code (e.g., CA, NY). + minLength: 2 + maxLength: 5 + example: "CA" + postalCode: + type: string + description: Postal code. + minLength: 3 + maxLength: 10 + example: "90001" + countryCode: + type: string + description: Country code (e.g., US). + pattern: "^[A-Z]{2}$" + minLength: 2 + maxLength: 2 + example: "US" + isLoadingDockAvailable: + type: string + description: Indicates if a loading dock is available ("Y" or "N"). + pattern: "^[YN]$" + minLength: 1 + maxLength: 1 + example: "N" + isResidentialAddress: + type: string + description: Indicates if the address is residential ("Y" or "N"). + pattern: "^[YN]$" + minLength: 1 + maxLength: 1 + example: "N" + + # RESPONSE SCHEMAS + + ApolloQuoteDetailsResponseV1: + type: object + required: [response] + properties: + response: + $ref: "#/components/schemas/QuoteDetailsResponse" + + QuoteDetailsResponse: + type: object + required: [quoteSummary] + properties: + quoteSummary: + $ref: "#/components/schemas/QuoteSummary" + + QuoteSummary: + type: object + required: [quoteId, status, serviceType, transitTime, serviceLine, serviceGroup, confirmationId, createDate, netTotal, validTill, originPort, destinationPort, nonConformalReasons, pricingDetail, estimateChargableWeight, estimateChargableWeightUnit, chargeDetails] + properties: + quoteId: + type: string + example: "AEA10002864" + status: + type: string + example: "ShipmentPending" + serviceType: + type: string + example: "DF" + transitTime: + type: integer + example: 3 + serviceLine: + type: string + example: "Air" + serviceGroup: + type: string + example: "NAAF" + confirmationId: + type: string + example: "326250024" + createDate: + type: string + format: date-time + example: "2025-11-22T15:48:54.8774961Z" + netTotal: + type: number + example: 0 + validTill: + type: string + format: date-time + example: "0001-01-01T00:00:00Z" + originPort: + $ref: "#/components/schemas/PortInfo" + destinationPort: + $ref: "#/components/schemas/PortInfo" + nonConformalReasons: + type: array + items: + type: string + example: [] + pricingDetail: + $ref: "#/components/schemas/PricingDetail" + estimateChargableWeight: + type: number + example: 7 + estimateChargableWeightUnit: + type: string + example: "lb" + chargeDetails: + type: array + items: + $ref: "#/components/schemas/ChargeDetails" + + PortInfo: + type: object + properties: + code: + type: string + name: + type: string + + PricingDetail: + type: object + properties: + rateType: + type: string + example: "Market" + message: + type: string + currencyCode: + type: string + example: "USD" + actualTotalPrice: + type: number + example: 290.26 + netTotalPrice: + type: number + example: 290.26 + discountDetail: + $ref: "#/components/schemas/DiscountDetail" + + DiscountDetail: + type: object + properties: + discount: + type: number + example: 0 + discountPercent: + type: number + example: 0 + discountValidTill: + type: string + format: date-time + example: "2025-12-31T00:00:00Z" + + ChargeDetails: + type: object + required: [shipmentPartyType, charges] + properties: + shipmentPartyType: + type: string + example: "SHPR" + charges: + type: array + items: + $ref: "#/components/schemas/QuoteCharges" + + QuoteCharges: + type: object + properties: + chargeType: + type: string + example: "AF" + chargeAmount: + type: number + example: 176.07 + currency: + type: string + example: "USD" + #Book Quote API Schemas + ApolloQuoteBookingRequestV1: + type: object + required: + - quoteId + - requestType + properties: + quoteId: + type: string + description: The quote identifier. + maxLength: 11 + specialInstructions: + type: string + description: Any special instructions for the booking. + example: "Handle with care" + pickupDetails: + $ref: '#/components/schemas/AirOceanPickupDetail' + requestType: + type: string + description: The type of the request (i.e, Air or Ocean). + AirOceanPickupDetail: type: object required: - - labelFormat - - shipmentNumber - - orderNumber - - charges + - date properties: - labelFormat: - description: The output format for the label - type: - - string - - "null" - minLength: 1 - example: PDF + date: + type: string + format: date + description: The pickup date. + example: "2025-11-15" + startTime: + type: string + description: The pickup start time. + example: "08:00" + endTime: + type: string + description: The pickup end time. + example: "17:00" + + ApolloBookingResponseV1: + type: object + properties: + response: + $ref: '#/components/schemas/AirOceanBookingResponse' + AirOceanBookingResponse: + type: object + properties: + quoteBookSummary: + $ref: '#/components/schemas/BookingResponse' + BookingResponse: + type: object + properties: + quoteId: + type: string + example: AEA10004707 + status: + type: string + example: "ShipmentInitiated" shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - orderNumber: - $ref: "#/components/schemas/ApolloOrderNumberV1" - charges: - description: A collection of charges associated with this Order. Conditionally required based on payer of charges. - type: object - properties: - shipperCharges: - description: A collection of charges associated with this Order mapped to the shipper - type: - - array - - "null" - items: - $ref: "#/components/schemas/ApolloChargeV1" - consigneeCharges: - description: A collection of charges associated with this Order mapped to the consignee - type: - - array - - "null" - items: - $ref: "#/components/schemas/ApolloChargeV1" - thirdPartyCharges: - description: A collection of charges associated with this Order mapped to the third party - type: - - array - - "null" - items: - $ref: "#/components/schemas/ApolloChargeV1" - additionalProperties: false - labelData: + type: string + example: "3460137373" + confirmationId: + type: string + example: "328250372" + bookingReference: + type: string + example: 00000000000A + createDate: + type: string + format: date-time + example: 2025-11-22T15:48:54.8774961Z + cargoDetails: + $ref: '#/components/schemas/AirOceanBookCargoDetails' + AirOceanBookCargoDetails: + type: object + properties: + isStackable: + type: string + isForkliftable: + type: string + isTiltable: + type: string + #Get Quote API Schemas + ApolloQuoteDataResponseV1: + type: object + required: + - response + properties: + response: type: object required: - - shipper - - consignee - - shipment + - quoteSummary properties: - shipper: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - consignee: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - thirdParty: - $ref: "#/components/schemas/ApolloShipmentPartyV1" - shipment: - type: object - properties: - shipmentNumber: - $ref: "#/components/schemas/ApolloShipmentNumberV1" - serviceType: - description: The service type associated with the Order - type: - - string - - "null" - minLength: 1 - example: AM - paymentType: - description: The payment type associated with the Order - type: - - string - - "null" - minLength: 1 - example: PPD - pickupDate: - description: The RFC 3339 scheduled pickup date. - $ref: "#/components/schemas/ApolloDateV1" - readyTime: - description: The pickup ready time. - $ref: "#/components/schemas/ApolloTimeV1" - closeTime: - description: The location close time. - $ref: "#/components/schemas/ApolloTimeV1" - dropoffTime: - description: The shipment dropoff time. - $ref: "#/components/schemas/ApolloTimeV1" - weight: - type: number - description: Total weight of the shipment. - format: float - maximum: 999999.99 - minLength: 1 - minimum: 1 - example: 10 - freightType: - type: string - description: Freight type of the shipment. - enum: - - PALLET - - LOOSE - orderDescription: - description: A short description of the Order - type: - - string - - "null" - minLength: 1 - example: WIDGETS - shipperReference: - description: A reference to the Order provided by Shipper - type: - - string - - "null" - minLength: 1 - example: ABC123 - consigneeReference: - description: A reference to the Order for the Consignee - type: - - string - - "null" - minLength: 1 - example: Z30010021 - currency: - description: The currency associated with the Order - type: - - string - - "null" - minLength: 3 - maxLength: 3 - example: USD - isMetric: - description: A flag indicating whether the units used are metric - type: - - string - - "null" - items: - description: AA collection of items - type: - - array - - "null" - items: - $ref: "#/components/schemas/ApolloItemV1" - countryOfManufacture: - description: An unbounded array of country codes where the items originated - type: array - minItems: 1 - items: - type: - - string - - "null" - minLength: 1 - example: US - details: - description: The extra attributes that can be used in a label - $ref: "#/components/schemas/ApolloCustomArrayV1" - rates: - description: The cost associated with the Order to be printed in the label - type: object - properties: - amount: - $ref: "#/components/schemas/ApolloAmountV1" - currencyCode: - type: - - string - - "null" - description: The ISO 4217 currency code - minLength: 3 - maxLength: 3 - pattern: ^[A-Z]{3} - example: USD - additionalProperties: false - sortCode: - description: The routing value to help the Ops Team - type: - - string - - "null" - minLength: 1 - example: U-BOS - gateway: - description: The airport gateway for routing - type: - - string - - "null" - minLength: 1 - example: "2" - count: - description: The total number of items in the order - type: integer - format: int32 - minLength: 1 - minimum: 1 - example: 2 - labelService: - description: The service entry used by the Ops Team - type: - - string - - "null" - minLength: 1 - example: ND - serviceDesc: - description: The description of the service - type: - - string - - "null" - minLength: 1 - example: UPS Next Day Air Freight - NGS - additionalProperties: false - additionalProperties: false - labelImage: - description: The byte array of the generated PDF represented as base64 string - type: - - string - - "null" - format: byte - example: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuZ3RoIDMgMCBSL0ZpbHRlci9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nD2OywoCMQxF9/mKu3YRk7bptDAIDuh+oOAP+AAXgrOZ37etjmSTe3ISIljpDYGwwrKxRwrKGcsNlx1e31mt5UFTIYucMFiqcrlif1ZobP0do6g48eIPKE+ydk6aM0roJG/RegwcNhDr5tChd+z+miTJnWqoT/3oUabOToVmmvEBy5IoCgplbmRzdHJlYW0KZW5kb2JqCgozIDAgb2JqCjEzNAplbmRvYmoKCjUgMCBvYmoKPDwvTGVuZ3RoIDYgMCBSL0ZpbHRlci9GbGF0ZURlY29kZS9MZW5ndGgxIDIzMTY0Pj4Kc3RyZWFtCnic7Xx5fFvVlf+59z0tdrzIu7xFz1G8Kl7i2HEWE8vxQlI3iRM71A6ksSwrsYptKZYUE9omYStgloZhaSlMMbTsbSPLAZwEGgNlusxQ0mHa0k4Z8muhlJb8ynQoZVpi/b736nkjgWlnfn/8Pp9fpNx3zz33bPecc899T4oVHA55KIEOkUJO96DLvyQxM5WI/omIpbr3BbU/3J61FPBpItOa3f49g1948t/vI4rLIzL8dM/A/t3vn77ZSpT0LlH8e/0eV98jn3k0mSj7bchY2Q/EpdNXm4hyIIOW9g8Gr+gyrq3EeAPGVQM+t+uw5VrQ51yBcc6g6wr/DywvGAHegbE25Br0bFR/ezPGR4kq6/y+QPCnVBYl2ijka/5hjz95S8kmok8kEFl8wDG8xQtjZhRjrqgGo8kcF7+I/r98GY5TnmwPU55aRIhb9PWZNu2Nvi7mRM9/C2flx5r+itA36KeshGk0wf5MWfQ+y2bLaSOp9CdkyxE6S3dSOnXSXSyVllImbaeNTAWNg25m90T3Rd+ii+jv6IHoU+zq6GOY/yL9A70PC/5NZVRHm0G/nTz0lvIGdUe/Qma6nhbRWtrGMslFP8H7j7DhdrqDvs0+F30fWtPpasirp0ZqjD4b/YDK6Gb1sOGVuCfoNjrBjFF31EuLaQmNckf0J9HXqIi66Wv0DdjkYFPqBiqgy+k6+jLLVv4B0J30dZpmCXyn0mQ4CU0b6RIaohEapcfoByyVtRteMbwT/Wz0TTJSGpXAJi+9xWrZJv6gmhBdF/05XUrH6HtYr3hPqZeqDxsunW6I/n30Ocqgp1g8e5o9a6g23Hr2quj90W8hI4toOTyyGXp66Rp6lr5P/05/4AejB2kDdUDzCyyfaawIHv8Jz+YH+AHlZarAanfC2hDdR2FE5DidoGfgm3+l0/QGS2e57BOsl93G/sATeB9/SblHOar8i8rUR+FvOxXCR0F6kJ7Efn6RXmIGyK9i7ewzzMe+xP6eneZh/jb/k2pWr1H/op41FE2fnv5LdHP0j2SlHPokXUkH4duv0QQdpR/Sj+kP9B/0HrOwVayf3c/C7DR7m8fxJXwL9/O7+IP8m8pm5TblWbVWXa9err6o/tzwBcNNJpdp+oOHpm+f/ub0j6JPRX+E3EmC/CJqhUevQlY8SCfpZUj/Gb1KvxT5A/lr2Q72aWgJsBvYHeyb7AX2I/ZbrJLkewlfy5uh1ceH4aer+e38Dmh/Ce9T/Of8Vf47/kfFoCxRVip7lfuVsDKpnFJ+rVrUIrVCXa5uUXeoUUSm2nCxocPwiOFxw3OGd4z1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FDH4Aj/4QFp+mdxGFHFbAimH3atbK2tgm9il2GfOwq9n17O/Yl9k97AH2LawAa+Am2O7gjbyDu7iHX8uv57fwo3gf59/nP+Gv8DOwPEuxKw5lubJR2aFcqgxhDUHlgHItPHub8pjykvKy8qbyG+UMopalLlZD6pXq3erD6lH1R4ZPGgbxfsBw0jBl+JHhA8MHRm7MMeYZK42fMT5i/KXJaFppajfdaPoX03+Y/SyPlcFybX614NnYg4v5YzxdPcjOAJHPVErGyh2IQwd2xX9QgzKNuCSJediWwbPVNMFpdKph8AfZCaplL9BBI1dQidXTFGG/4KfV5/lF9GPWw7LVh5Uhww94AT2OanSYP81PsPV0lNfzS/i9CrE32CP0BvL9CrqDXc4C9Dg7w9awz7M6dpD+hWcqHexaqo8+wFUWxzaydwgW0FVqH33646sgW02/oLemv6omqp9DfZqkuxDRb9Br7FH6MzNE30Z1U1CNXKgyNyPfryNR9XZinx3EfsxGBRkwvkRHxYliqjOuU6+kd+g/6S3DcWTUelTSN6e96lfVX0XrouXYYdhl9Aj2XT9djB3zBrLkGYzF6DLs9HjUkmrs6nbaQX30eVS926Lh6L3Ra6L7oz76R/D+mS1jf2Zj2BGT4Kin7+H9RfoZuwn78OL/3ikw3UdT9FtmZYWsGvvhjGGf4bDhMcNRw7cNLxqXw9vX0j3I6F8im+OxAjf9iH5Lf2JmxCabllEN7F0F27togHcrz1ATyyE/9mwJ6vh6fSUBSLka3rsX+/kZ7I13UCcuo2/TK4yzLKzIDf1myGmDn3eB+iFE8Bo2AUwfqnYZ/Q7rTmKreBD6nJB0F6rWFGz6Bf0a3o5Ku5ahLjSzSyDrT/Qp6oOGldTOxhGBJ2k1Kmuz8k/w91JmofVsCfs6+HqwQ5Mon1YbfsU4LZveHF3FvcozOGOiwI/h9Mqli9heWJGMdZylDLaFaqe3wYaXiZyNnc6GdRfVr12zelVdbc2K6uVVlRXlyxxlpSXFRYVL7UsKNNvi/LzcnGxrVmZGelpqiiU5KTFhUXyc2WQ0qApntKzF3tqjhYt6wmqRfcOGcjG2u4BwzUP0hDWgWhfShLUeSaYtpHSCcveHKJ0xSucsJbNo9VRfvkxrsWvhF5vt2iTbsbUL8C3N9m4tfEbCmyR8WMKJgAsKwKC1WPubtTDr0VrCrfv6R1t6miFufFF8k73JE1++jMbjFwFcBCicZfePs6x1TAI8q2XNOCdzIowK59ibW8LZ9mZhQVgpbHH1hdu3drU05xYUdJcvC7Mmt703TPb14WSHJKEmqSZsbAqbpBrNK1ZDN2njy6ZGb560UG+PI6HP3ue6rCusuLqFjhQH9DaHs6583To3hPDUpq7r58/mKqMtVq8mhqOj12vhqa1d82cLxLW7GzLAywtbe0ZbofpmOLGtQ4M2fl13V5hdB5WaWIlYVWx9HnuLwPR8RgvH2dfb+0c/04PQ5IyGadv+gkhOjvNY9DTltGijnV32gnBDrr3b1Zw3nk6j2/ZPZDu17IUz5cvGLSkxx44nJetAQuJ8wDM7JyFJLqC2bbOeZcIi+0YkRFhza7Cky441rRIXzyoada8CGV7dDFzhPkTEG45r6hm1rBF4wR82FFrs2ugfCRlgP/P2QoxLxxgLLX8kAYo8mU01zM/AYYcjXFYmUsTUhJjCxnVyXFu+bN8kX2n3WzR0cB+1w7eu7jWVcH9BgQjwTZNO6sUgfGhrV2ysUW9uhJyVju4w7xEzUzMzGdvFzKGZmVn2Hjsy+ah8EMgIm4tm/yVbMtNa+teEWebHTHti820d9ratO7q0ltEe3bdtnQtGsflVs3M6FE5r6lJyuQ7xXEXOIikvmyUWg66EsFqIf0aZ1H1hBUkpEUxrDVt6NsSu3fEFBR/JM2kyz2OajL4juGQ3x6ZbGV7jWDheu2C8wLqEUQX2qkW8rXPH6Gj8grlWFKDR0Va71jraM+qajB7qtWsW++gx/jB/eNTf0jMT0Mno8Ztyw603d2MR/WwNkpXT+nE7u2HruJPd0LGj65gFT283dHZFOONNPeu7x5dirusYbkWcEstnsWKkiRG1MSR6hJvlVO4xJ9EhOatKhBy7JxlJnHkGx8g9yWM4i8ThVY7bFBF8A9449U20/ihn00bTJG9wppFBnVYo3qROM8o2Gw3TXHmaFVEcbnatZHVY3qs/W7/Z8m79prP11ADY8gEuy6sKUgpSCnFhuIH4QFOmPnAa6C+kqVPQhScYMrjwnGUhGx10rigxlMRfnOVRPQmGsqzVWRsyuzP7Mw2rs1bmXp97t+GuRQZbSiEjnpZamGwxZxcfMTHTZHRqIm5RDUy82Zl2qIBpBVUFvCAlVSPNUmXhlkl+04S2vMPqgGk7hW2bLDv3vufYu+mMNLJB2kg797KdaQXVWZmZqRnpuBfE217AUlZU163jtTVFRcVF9jt4/lM9V032lNft3nRN79fPvsxKXv1c3YZd9fUDHeueMBzPK3pu+s0fPnHNmLutzKY+90FtUuolLzz22JO7U5PEs/ct0d+oHbivy6R7nVmfStmTcpdBiTNmG+t5fUobb0t5k5uSJ3nQmaIuyqT4jPT0+DhjWnpRRgZNslJnUqZTW1pzJJNFM1lmjhWLdmYuWVpz2Dpm5X7rO1b+eyuzxi8qijOLqWTQjpnZO2Zmzs5qqJdr3zvsEKvfjNUPO95D23Sm3iIjVW+BFxrOCC+wnQW1RqN9SVFRLaKWnpm5onrlSgEqm9c84738sU+ybNu2hg3DZSz7vu29n37sLj42bT3tWbsl9Dqb+svPxToP4H73y+o6KmZrj1EpjNmZEt9gMBoTMoyZCTVKjbnGWmNv5i3mFmuzPUFTKks74npKD5XeV/p148OmhxKeMD6REC49VXq6NIlKK0vbMXGy9LVSY6kzJ6+mAeNDctJgKlBNOfmZcFkk3lQgPLdYNVlSUopz8/KKiuMZGZMtRakpzh21PSnMl8JSJnmrMzkntyg/DzhfHuvJY3nAHS1EdBl8HCEqFsmUHNcgeudK2F0M0mJnI1o92tLimmLnmotqKotfKn6tWEkuthUfKlaoWCuuKo4Wq8XZJb+K+Vq4OPZCtp2Bl9/budeBRHtv707RwefS6+LdcKbhDEtJXU1oy6vYsGPvToTBkVaQsXJFdWbWSnnNzEAIapCDS4xGCRbNgAeYctPU7ruqWh+4LPRASf70m/nFW9f2V0y/ubhhZWN/+fSbatFtj3Zu396567LmL5/t5ru+WlG/4aa7pjlvvWfHstZr7z77AWKWNL1V3YbcTGM1R1NLDCxtMnraaU1IrjFnJibXmMTFKC6GTOC4cI4tZ00NgqomLkoyWjilGdU0rioKg9vTeizMMsmOOFMXJSdWJpWQllGV0ZOhvJPBMoR/lxTViN6Zmre4JiMrK0ddrTit2TUHFaZMsmJnHJcjVD8xSsXTiTNvZY1GVagW2enfGYs52LHpbDau+Gc9u7nF0/xrh2Pv8CbLu69Tw5mdlQ3StSx1dYr0a+pqAKYki9joDibjsrMtbOloC69BxY+oFjoefYdY9J1xBc/veHXjRDlGhuhvnEmJKQ1plrRsXFKtDQacIRMYiD6CcUxWd1pBWloBMyUp9iXFxWLL1CUxx/T7zD59Y1Nh06cOtm/dnL2+tvfT2WrR2ST+hw/4sZ29Fy1J+UVioFvUwDvxLPg+amAy7rdHnIVGw7H0Y1blYgPbY/iJgaemFCYmJVGupRAuSSZz5jlVL9OWX5Xfk+/PP5RvyLckayzmLFH48hYWvtm6J6pe6urKudq3IqVAQ/HLSDeKymfP5nLj14i6dyf7V5a07cBjvV/a/JnvP/vAkX1Nn95QO2Y4nlnw6pHrJ70pGWd/qj433VPR29jenxiPbPoS1nMt1hNHw84Gs0E1GgpNmrnKfNL8mlmtNB82c7OZFFWsJ47MpgbjFjyKb1Nw8vAcbVHVIr5IjZu/iPj5i0D9eg8ABnPL2LkXvWKw1GM1WEhGgWxfUs6cXcv7zt5rOP7+9IPvn71NVCcrHP5rw8uowpPO6pUqK1M1i5bSrR6yGszqSSvPyEzh6amZKUlpyWRJSmNk4elx5uRFbNeiKAwTZSbeyFKSY4VYVh2c13jYFomPkr2iwbzF3G5WzCWWypRdKTxlkqnOxKS0Ip6+i8YypzJ5JkL3ZFxCTWZ21hXHuJfk0hx76zeJ0/KDnfXv7sx+naxYm1gVWgMuq6uT8UJ5EMUhbUVtjSgLWSZRBDIyVmTYURLs1ntX3x26IlDUtO6i2n/+5+k371WL2r9wbcfS71hWb2179YOnlI0i126Hsd9AbMTZPnKM4rAPG1DnnHHtcfxQXDhuKu5U3O/jDLa4nriDcWNAGBSjCQe/kkzMSafwxKjQTtwiGA1GkxrPTUVMFXs5rmBpjZpt1o8ah34LIAOEJcjQyOhgAcOONJjL0G5n2dNvsmz1SaZOf/CXT6hFOEDYPAs7xBaccpYK+wztBn7IEDZMGU4Zfm8w2Aw9hoOGMSAMMAY3JVwpYjRjCWWr51ii614R02s4/udWeKMRZ3Ixzqp0ymNfO0aW6PvO1kWr7477SuJdlkcMD8efiDuROJljNqezDfxiY2v8lsWPJD5pfDLnu/HfS/hJ/CsJ75v+lJiYl5yX4czNr8lwJqXUJGeczHgpQ5GFLnlxg+yTstDzW5wJyUmp7Uk9STzJmspEFmTn1rAVqcLsiXytRvZLSmO9ozzWW/Nk70xOSq4ZE/flFpi9KzUVmTehLkq1igxcushEBawyo2BLEkvKqVy8a7Fv8X2L1cXJBWYnirY5O9/bGPPGpjNy+2w68y6KwBkUOWe61VmS3mB1Lk7GJdeCS15KgyxqDWdlEUyFEaBIFcaASPagE31khhTnnSyEkoEwgeNMzGeJLjwRF79ODhsLGhwk6F93oCjvlOqTnPBSklCaJNQnOeEskkJRnBwOHKP1uAtD8HbupZ0OhiPHrhUX1VpoRTUpBfL+JE0chiZjFv8zs65868j0767zsvSXz7BU41mncrVr/Y5i5YpLLquvZ2xb5Vfuf+K2V5kZ1fm70898/qYNbODKg01NAfkxmPiI79d7nvlx/8ldyfV/NGeb5adDD/yqfu5Tf5reavwyqgdDbWMzH58RmdZNb6amuQ/UPvQBU4IRKMN36Q71V3SLKZ8OqAFK4qtx53sJ3Qncl/hjZMX4dtEw1wielfQ4s7H/5JN8UtGUIeV/qw1qyPBZXXoClSANxIsjISppO+65Nlt82AgCu0u9ksTduzRYXhXJFy9HiuTCnaEOK9TFLDqsUjrr12EDWdnndNgI+A4dNtF32Dd02ExF3K/DcTTK79LhePU5RdPhRdRr+qUOJ9Buc7MOJxqPmh/T4SS6LPnTs347mHxch+E2y2od5qRa1umwQsss63VYpXjLkA4bKMFyhQ4bAV+rwybqtRzWYTOlWf6gw3HUkmLQ4XjuSvmEDi+i5WmPz35btiLtFzqcqOxIT9bhJKrI8sISpgqvJ2V9SYdVysl6UMIG4OOzTuqwSplZ35ewEXhj1ms6rFJq1hsSNom4ZP1JhxGLrKiEzcAnWNN0WCWr1SbhOBFfa50OI77ZtToMOdkNOoz4Zl+sw5CZfZ8OI77ZEzqM+Gb/ow4jvtm/0mHEN+dhHUZ8c17UYcQ391M6jPhq2TqM+Gqf1WHEV/tfOoz4Ft8p4Xjhq+J/12H4qji2xkXAp5Zk67BKi0scEk4QaynZqMOwv2SrhJNE5pd4dFilvJKQhC1Szm06LOR8TcJpwuclz+owfF7yXQmnC3tKfqbDsKfkTQlnAJ9eynRYJa00Q8KZgr60VodBX9ok4WxJv1OHBf1eCeeKHCi9TYeRA6X3SDhf2FM6rsOwp/QpCdsk/fd1WNC/LOGlIgdK39Jh5EDpHyVcJvxTlqjD8E9ZzM5yUQnKSnVYnYHN0v+zMOwvk/ljlusq26rDAr9LwAkx+v06LPDXS1jGpex+HRZ6H6VO2k9+8tBucpEbvUaPonVSv4Q3kY+G0II6lYaK6aNhwOLqAt4rKTRgBsBfAahZ4l3/Q0mVs5Zp1IGZAQrN0gSA24g+pm85rca7isp1qFpiG8ExgH4bePbAhqDk2gZ5AbRh2odrH6iGMe8C5Xqpo+8cO9fMo9FmqdbQJVJKYNbqFdBahbeGKr8JWDdmfZj3wbNBKj2vlI+SMUdbPs+uznn4b0nPCr/1QcYg+mG6HDih7b/vcw1YD7zlhU1BaZvwkYaxoAnqUrcjHhq1S36NiqS+Tbhuge7d0vcu0As+D6QKb49ITiGt4jw2xeLsg15hkx+0+z+SyiPzS9CNSKv2zOr16tlbLqPso17d6s1ypl960QVrls3aPixnvDJTO3ANSatjEYll1SrkUpO0JCi9POO3Ydiigcql52Iso7zS930yw0TODUld8+Pu1mW5pG2Cc1BKFHb3Q/+glBjzviatdkl9bj0asRlhdUCPh0uuMca3fzb+Xj3b/XoEPdI3AZmNsdXNRMil2x+S2jSpYb5VM5EXvhHjESm7f142CFqflBXTPYOPeTuoe8StZ2rgHLogZHqkV7zoY7LdOiYkPS0yai6nfXLnDkuPDkh+YamI56DONaPBLfn36Vq9+kpj+1FImPPCblAKaTHsnF+9und9+kq8kj4kR3NRDcgsHZDWnT8nZmprYHYtYm5QypuTIerF5bq1Lt3/bln1NH2XzvisT+reI7ExfrHDvHoM++W+8+s54sNV7Oh9urdjEuaqvUvGKpYdmvShW1+/V0ZtQNL45d6LZeOQ5IytZH52e2czS+z8K/TIDEprRG7u0/dWrO4MzNoxKEdz2Rv80IkU+ND63LqOXikhJD3dtyA3PbQX+BnPitx2z65wt8xtTebAFdK3AZl3wdl6Eou6sD2234N61YjtpoCeZXPVMzY7KCPioislf8xqIdctZ+cyLaa9T3rLL3fJ/tlVzOgekjVTzLukJ4Z1HWIPxbwYlPwzFs9I98scGpR1c8a2Cnn2BTG3BmdqJeSKd4Wkml9hK2R1GgRFv9xLA4AGAQ3JCHnkKEC7ZA7EIl4xS/l/V8OIzJgYrWeels2o9J0491vRmpB5At4CrDgBWnH9pMS3ANOBq8jNi3EStOC9SWI7KRFPU6J1ymwKnCfXtFl8bJ/EPOrXfT6Xo3/dKTYXmZmKPBPnXjm7H/ShWZ3u2doWy+e582h+tYxVjrk6Gtu/Xr1mBvQ9vUdK8czWRLFbu3VtYnfv02tp7+xpFNMZ/BjPzNTOkdnq5NF3nGc2p4dl/Qjq+3m3no/n89fMLhQe88yTMreLz9XXp5+AIgN7ZWWMWd2rR2ZIl3y+CBXLVS30VKwin5sV52qeqW2iirnkvagLWgd0bwf0GvJRuoX3twMzV2f3nxMLj36XMf+eK1a9XdIiv/SsV7/T+Wtirum5ODSvts3oFZWkT3raO+8UGZ53r7xslnp4Xt7Ond0f7ylh3aCUP5NXvgXyRmT8L5fRnH8fOlMf5yh9oI3doYakx4X8/tn1xOyan92DekWN+T+2q/x6fsxV3oU59HErmsuPjXLt50Zu5t5LnDke/Q4ttprY/Z5bRnXoQzEY/pC/5yQH5N1qSN71x86hffLeaITm313919GfkTes3/959Wee893FnRvHmLfm7ljdUua5+3gmYq4P+Xr332TtnJfP1bDwvF9okUe/iw3i7JmRIJ5PGin2JFCCe/gaqsPzl4brcozK8XxVI5+yxKcj26lNp6zC7HLM1OhwHZ7G6iTXSqrFs4BoQvrfdtb990/GmbnKD3lv9jzs3O/37Ha5PdqjWme/R9vkG/IFgdKafMN+37Ar6PUNaf4Bd4XW7Aq6/guiSiFM6/ANhAQmoG0cAt/y1aurynGprtAaBwa0bd49/cGAts0T8Azv8/Q1DntdA+t9A30zMtdIjCZQay7xDAeE6BUVVVVaySave9gX8O0Ols6RzKeQ2HIpq1PCj2idw64+z6Br+HLNt/tjLdeGPXu8gaBn2NOneYe0IEi3d2jtrqBWpHVu0rbs3l2huYb6NM9AwDPSD7KKWUlYs2/PsMvfv38+yqM1D7tGvEN7BK8X7i3Xtvl6IXqz193vG3AFlgnpw16316V1uEJDfVgIXLWqusk3FPQMCtuG92sBF7wIR3l3a32egHfP0DIttnY3qFxeTA76hj1af2jQNQTzNXe/a9jlxjIw8LoDWIdrSMPcfrF+L9zuxwI9bk8g4IM6sSAX5Ifc/ZpXFyUWHxryaCPeYL90w6DP1ye4BQyzgzDEDacGZnDBEc9Q0OsBtRtAaHh/hSY97dvnGXYh3sFhjys4iCnB4A4h5gGhTMTRMyxN2B0aGAAobYX6QR+UeIf6QoGgXGoguH/AM98TIlsDQotneNA7JCmGfZdDrAv2u0NQFAtgn9e1xyfmR/rhc63fM+CHR3zaHu8+jySQae/SBuAObdAD3w153SB3+f0euHHI7YGSmLu9wlma5wosZtAzsF/D2gLInQEhY9A7IN0b1DdSQNfnBkevRwsFkFLSm569IWFsyC38r+32YcmQiEUFgyJPsPRhD+IeRGogTAG4TKYnhoOuPa4rvUMQ7Qm6l8WcBvY+b8A/4NovVAjuIc9IwO/ywzSQ9MHEoDcgBAty/7Bv0CelVfQHg/41lZUjIyMVg3rCVrh9g5X9wcGBysGg+NuSysHALpdYeIVA/pUMI54BYD2SZfOWzo2tG5saOzdu2axtadU+ubGpZXNHi9Z48baWlk0tmzsT4xPjO/vh1hmvCReLmMBQrCAoPXqeLSYXIxJZrLl3v7bfFxKcbpFt8LPcR7G0RHLIHEV8sf2GQO7aM+zxiEys0LrB1u9CGvh6xTYCZ3CBMSI7R0Q6eRA4j/D0sMcdRJx3w49zdokQ+vZ4JIkM8SwfQoPs7Q0FIRpm+rCj5i2oODBjFBJ51hWzzCLbtH2ugZCrFxnmCiBD5nNXaNuHZM7un1kF1qRXLqS3Swv4PW4vis65K9fgxSGZbYLX1dfnFTmBrByWVXmZQA9L38rd/SGjBryDXrEgKJF0I77hywOxJJX5KJG+ERTUUO+AN9Av9EBWzN2DSFTYj1D592ux5NU9tFCR9MfG3XOLE9Vrb8gTkGpQ99ye4SF9BcO63ZI40O8LDfRhD+3zekZi5eqc5Qs6RNKDCtA3V+Jm1wizZGF1B+diLBbm0q3efX6x0uRZBn3f64KgxxVcIwi2dzTiEChZVVNXqtUtX1VeVVNVFRe3vQ3IquXLa2pwrVtRp9WtrF1duzox/iN23cduRjGq1M2T+xCPqx79Jknc6sz/mGXhTJBCLBG3Bm8toJnD7qaFH3NrOqZV/9Bj/oyOU25QnlG+o5zEdXz+/AL8ha8NLnxtcOFrgwtfG1z42uDC1wYXvja48LXBha8NLnxtcOFrgwtfG1z42uDC1wYXvjb4f/hrg9nPD7z0UZ8sxGY+iT6WrT6JCS2gPXf2Ylk1AguoZnCt9BbGl9N7oH8LuIWfOiycm+GZub/ynVfi3OwlEppPE8NskKN98vOOhfMLZ9r10zckn/18clfOpz7f/HxP+T7Shz7Vpq5T16pN6kp1lepUL1Lb1NXzqc8733neT3TmsK3nrCeGaRMjthw08+fmsG36venlH7J4Hp6l0C8VO7Jk3vws7q/Nm7/SN3+1vI/LK/3/y1O0mH5K53l9mzqVr1AyY2SLTilfnrCkVzsnlbsnktOqnY0W5U5qR+MUVjbRFBonn3IbHUTjIG+LlC+vPiaAifikagvobyIN7RCaQmO4Mjl2ogn6mybSMoX4ayLJKZLvs5GqmhgwYbFWtzemK1cQUzzKENnJphxAvxi9G30++l6lD5VC2OmcSLZUH4K+BpA3KBkoQzalUcmkavTNSg7lSrJQJCmmJxQpKatujFeaFKskSVYSUY9silkxRapt2glF/NmwU7lhIm6RsO+GiCWj+hnlOsVE6aA6BKosW/IzSjxVoomVdE7EJVYfbkxQOrHMTrjFpoj/rH+fvDqVoQgEQV+LkkeZmLtcyacM9K3K4kiGbeqEcrsk+zshBfrWRcwrRDeRmFQ91RiniL8HCCu3wuO3Sm2HJ4pWVVNjkVJCVYr4EwlNOQjooPjP4soooFGEaRShGUVoRmHFKBkR+RsxcyNoKpUrya+M0GG0+wCrEJkRgQePSWBpSfUxJVuxwhOWE/AdAzZnIi5JWGaNpKZJMutEQlJ1wzNKgLagcRgfnMiyVvtOKGVyKcsmrLmCwR+JS4DrsmKxAGOmiMEzSp6yWHoiX3og3GjDmFGyYiPGf8BPCe/wl/mPRXzFT/rI/h/1/kW9/2Gsj07xUxPQ4pzk/yz60415/A0I28VfpfsAcX6CP4+jxsZ/zieFFfxn/Bg1oH8F4z70x9CvQH88UvA92ySfnEAH2++JJGaKxfLnI45KHbAV6kBWrg6kZlY3FvLn+LOUBxE/Rb8U/bN8ipagP4nein6KB+l76J/gtbQW/VG9/w5/WuQ0f4o/iTPTxiciScKEcMQkuiMRo+i+FaHYqL3S9jT/Fn+cckD6zUhRDrCPTBQttSWfgDzGH+TBSL4ttTGe38+62LsgGqNXRE+p/IFInRByOPK0ZjvGD/PDTmuds9BZ7nxIqSqsKq96SNEKtXKtTntIa7TwW8kA52HD8ptwxfnMkT1oTrTD/MaIWhduPIs1iXVxOoTrmIR6cPVLiHC1zM6+I6EGfh1tQeOQcQDtINohtKtIxfVKtM+ifQ7t8xITRAuhjaB8+MHhB4cfHH7J4QeHHxx+cPglh19qD6EJjh5w9ICjBxw9kqMHHD3g6AFHj+QQ9vaAo0dytIOjHRzt4GiXHO3gaAdHOzjaJUc7ONrB0S45nOBwgsMJDqfkcILDCQ4nOJySwwkOJzickqMKHFXgqAJHleSoAkcVOKrAUSU5qsBRBY4qyaGBQwOHBg5Ncmjg0MChgUOTHBo4NHBoksMCDgs4LOCwSA4LOCzgsIDDIjksMj4hNMFxGhynwXEaHKclx2lwnAbHaXCclhynwXEaHKf5yLhyqvEFsJwCyymwnJIsp8ByCiynwHJKspwCyymwnNKXHpTO4EibA2gH0Q6hCd4p8E6Bdwq8U5J3SqZXCE3whsERBkcYHGHJEQZHGBxhcIQlRxgcYXCEJccYOMbAMQaOMckxBo4xcIyBY0xyjMnEDaEJjr89Kf/m0PCrWJcZhys/xEplf5Delv0BekX2n6dx2X+OHpL9Z+lq2V9JdbIfoSLZQ57sg2Qzs4itLrkxEyVgC9ouNB/afWhH0E6imST0EtpraFFe61yiJpu2mO4zHTGdNBmOmE6beLJxi/E+4xHjSaPhiPG0kWuNuTxR1lGUFvqivB7E9fdoOERwbZBQA6+B3hrU2Vq8a3iNM+WM9vsy9lIZO1nGjpSxL5axxjh+MVNlpcOdPofhrMuZULTO9gpaXVHxOlSmW598O8sWKVppm2RPx7pSpwP922jjaA+hXY1Wh1aNVo5WiGaTuDLQdzmX6CKfRitGK0DThArKzMTdTWqK2XmMJ7KHJl5IpDihp7gEfCcixVXoJiPFW9A9FSnutTXGsSepWNwGsScQucfRH4nYXsf0N2PdNyK2E+geidhq0O2MFFeguzRS/KKtMZFtJ5sqWDv1vgPrFv22iO0SkG2N2ErROSLFRYK6DIoKMVvKuuh19IU619KYJnvEthbdkohttaA2U7EIPDNSuTTPgCZ6ZQIG/f4Y61KZc5HtjO1229tg/x0ci/T4mTaponupcJJd4oy3PV3+VRA32iKN8YIe58O43odF/4TtocIbbfdAFit80na3rcJ2a/mkGehbYPeNUkXEdrU2yR93ptkO2apswfLXbQHbJ2wu2zbbzkLgI7bLbE8LM6mbdfHHn7S1Q+BGrKIwYru4cFKa2Grbb3Paim2rtaeFf2lVTG5d+dPCA1Qd074M/i0rnBQ5vr1ukqU4y0zvmA6bLjWtN6012U1LTItN+aZ0c6rZYk4yJ5jjzWaz0ayauZnM6eLnHRzizyvTjeKv18moiqsqYQsXVx77S1POzJw+QeE0pY23daxnbeEpN7X1auH3OuyTLH7rjrDBvp6FU9uorXN9eJWjbdIU3Rauc7SFTe2Xdo0zdms3sGF+wySjzq5JFhWo63LFD1GNM7rultxjxFj2dbd0d5M1c1+DtSF1Xcrq1ubzXHr0q2PuZZ0P5ofvauvoCj+W3x2uFkA0v7stfJX4mapjPJkntjQf40mi6+46pvp5css2gVf9zd0ge12SIZuTQEbFogOZeT1pggz1ZL0gQ4xidEVgB12B6EAXn0hFkq4oPlHSqUzQjb+itTSPa5qkKSR6RdK8UkjzaJAx4G0eLyqSVHaNdQkq1mXXpGGlUpDNBpJymyTBk5tNCrIxqSxcOUdSqJPUzpLUSl0Km6OxxWjSS2Zo0ktA4/gfvjzrHWxieejA8+KXv3rsLR60nvBN+/qt4UO9mjZ+IKT/JFhRT6+7X/QuTzhk9zSHD9ibtfHlz59n+nkxvdzePE7Pt3R2jT/v9DRHljuXt9hdzd0TDfVdjQt03Tirq6v+PMLqhbAuoauh8TzTjWK6QehqFLoaha4GZ4PU1eIVed/eNW6m9eJ3QWQ/wRfFI4d7cgu612da/OtEQh9bW2A9kHtcJfYILXJ0hxPs68OJaGKqvLG8UUxhn4mpJPHzbvqU9cDagtzj7BF9ygJ0in09zbiWBFFbuHZrW7igY0eXSJWw03X+mAXES05bqcXbjH8YB2XDez4lBc77Cp7vFQqFAuIScuApuS1c1tEWXrkVlphMUNXT3A1cxQxOUSRuPC6uZTI6hUkHjGBBoU5ADiZ+I8AZj6cuEx8zjpm4eFQITuTkV/uewQl+EA3PcXwkUimfl/nIxJJC8fwSnKisjfV4PhV9JKegWvwUQR1YRV8Y650p5QAOFx4uP1w3VjhWPlZnFD+08BCQtofEURqpfEihoCMw4wiAwW6K/XQB9N0fycuXiscE4HB0OwLyN17ow6526L8jA6fPOjagSw1I8cGZgMTwAYoRxyYdoRmmkM4iJ0OSRSr8P1jbNhMKZW5kc3RyZWFtCmVuZG9iagoKNiAwIG9iagoxMDgyNQplbmRvYmoKCjcgMCBvYmoKPDwvVHlwZS9Gb250RGVzY3JpcHRvci9Gb250TmFtZS9CQUFBQUErQXJpYWwtQm9sZE1UCi9GbGFncyA0Ci9Gb250QkJveFstNjI3IC0zNzYgMjAwMCAxMDExXS9JdGFsaWNBbmdsZSAwCi9Bc2NlbnQgOTA1Ci9EZXNjZW50IDIxMQovQ2FwSGVpZ2h0IDEwMTAKL1N0ZW1WIDgwCi9Gb250RmlsZTIgNSAwIFI+PgplbmRvYmoKCjggMCBvYmoKPDwvTGVuZ3RoIDI3Mi9GaWx0ZXIvRmxhdGVEZWNvZGU+PgpzdHJlYW0KeJxdkc9uhCAQxu88BcftYQNadbuJMdm62cRD/6S2D6AwWpKKBPHg2xcG2yY9QH7DzDf5ZmB1c220cuzVzqIFRwelpYVlXq0A2sOoNElSKpVwe4S3mDpDmNe22+JgavQwlyVhbz63OLvRw0XOPdwR9mIlWKVHevioWx+3qzFfMIF2lJOqohIG3+epM8/dBAxVx0b6tHLb0Uv+Ct43AzTFOIlWxCxhMZ0A2+kRSMl5RcvbrSKg5b9cskv6QXx21pcmvpTzLKs8p8inPPA9cnENnMX3c+AcOeWBC+Qc+RT7FIEfohb5HBm1l8h14MfIOZrc3QS7YZ8/a6BitdavAJeOs4eplYbffzGzCSo83zuVhO0KZW5kc3RyZWFtCmVuZG9iagoKOSAwIG9iago8PC9UeXBlL0ZvbnQvU3VidHlwZS9UcnVlVHlwZS9CYXNlRm9udC9CQUFBQUErQXJpYWwtQm9sZE1UCi9GaXJzdENoYXIgMAovTGFzdENoYXIgMTEKL1dpZHRoc1s3NTAgNzIyIDYxMCA4ODkgNTU2IDI3NyA2NjYgNjEwIDMzMyAyNzcgMjc3IDU1NiBdCi9Gb250RGVzY3JpcHRvciA3IDAgUgovVG9Vbmljb2RlIDggMCBSCj4+CmVuZG9iagoKMTAgMCBvYmoKPDwKL0YxIDkgMCBSCj4+CmVuZG9iagoKMTEgMCBvYmoKPDwvRm9udCAxMCAwIFIKL1Byb2NTZXRbL1BERi9UZXh0XT4+CmVuZG9iagoKMSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDQgMCBSL1Jlc291cmNlcyAxMSAwIFIvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL0dyb3VwPDwvUy9UcmFuc3BhcmVuY3kvQ1MvRGV2aWNlUkdCL0kgdHJ1ZT4+L0NvbnRlbnRzIDIgMCBSPj4KZW5kb2JqCgoxMiAwIG9iago8PC9Db3VudCAxL0ZpcnN0IDEzIDAgUi9MYXN0IDEzIDAgUgo+PgplbmRvYmoKCjEzIDAgb2JqCjw8L1RpdGxlPEZFRkYwMDQ0MDA3NTAwNkQwMDZEMDA3OTAwMjAwMDUwMDA0NDAwNDYwMDIwMDA2NjAwNjkwMDZDMDA2NT4KL0Rlc3RbMSAwIFIvWFlaIDU2LjcgNzczLjMgMF0vUGFyZW50IDEyIDAgUj4+CmVuZG9iagoKNCAwIG9iago8PC9UeXBlL1BhZ2VzCi9SZXNvdXJjZXMgMTEgMCBSCi9NZWRpYUJveFsgMCAwIDU5NSA4NDIgXQovS2lkc1sgMSAwIFIgXQovQ291bnQgMT4+CmVuZG9iagoKMTQgMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDQgMCBSCi9PdXRsaW5lcyAxMiAwIFIKPj4KZW5kb2JqCgoxNSAwIG9iago8PC9BdXRob3I8RkVGRjAwNDUwMDc2MDA2MTAwNkUwMDY3MDA2NTAwNkMwMDZGMDA3MzAwMjAwMDU2MDA2QzAwNjEwMDYzMDA2ODAwNkYwMDY3MDA2OTAwNjEwMDZFMDA2RTAwNjkwMDczPgovQ3JlYXRvcjxGRUZGMDA1NzAwNzIwMDY5MDA3NDAwNjUwMDcyPgovUHJvZHVjZXI8RkVGRjAwNEYwMDcwMDA2NTAwNkUwMDRGMDA2NjAwNjYwMDY5MDA2MzAwNjUwMDJFMDA2RjAwNzIwMDY3MDAyMDAwMzIwMDJFMDAzMT4KL0NyZWF0aW9uRGF0ZShEOjIwMDcwMjIzMTc1NjM3KzAyJzAwJyk+PgplbmRvYmoKCnhyZWYKMCAxNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMTE5OTcgMDAwMDAgbiAKMDAwMDAwMDAxOSAwMDAwMCBuIAowMDAwMDAwMjI0IDAwMDAwIG4gCjAwMDAwMTIzMzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAowMDAwMDExMTU0IDAwMDAwIG4gCjAwMDAwMTExNzYgMDAwMDAgbiAKMDAwMDAxMTM2OCAwMDAwMCBuIAowMDAwMDExNzA5IDAwMDAwIG4gCjAwMDAwMTE5MTAgMDAwMDAgbiAKMDAwMDAxMTk0MyAwMDAwMCBuIAowMDAwMDEyMTQwIDAwMDAwIG4gCjAwMDAwMTIxOTYgMDAwMDAgbiAKMDAwMDAxMjQyOSAwMDAwMCBuIAowMDAwMDEyNDk0IDAwMDAwIG4gCnRyYWlsZXIKPDwvU2l6ZSAxNi9Sb290IDE0IDAgUgovSW5mbyAxNSAwIFIKL0lEIFsgPEY3RDc3QjNEMjJCOUY5MjgyOUQ0OUZGNUQ3OEI4RjI4Pgo8RjdENzdCM0QyMkI5RjkyODI5RDQ5RkY1RDc4QjhGMjg+IF0KPj4Kc3RhcnR4cmVmCjEyNzg3CiUlRU9GCg== - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: + quoteSummary: + $ref: "#/components/schemas/QuoteSummaryV1" + + QuoteSummaryV1: + type: object + properties: + quoteId: + type: string + example: "AEA10004706" + status: + type: string + example: "ShipmentPending" + confirmationId: + type: string + example: "328250356" + shipmentNumber: + type: string + example: "3460137351" + serviceType: + type: string + example: "DF" + transitTime: + type: integer + example: 3 + serviceLine: + type: string + example: "Air" + serviceGroup: + type: string + example: "NAAF" + movementTypeCode: + type: string + example: "DTD" + incoTermType: type: string - additionalProperties: false - ApolloOrderNumberV1: - description: The Unique number used to identify the order - type: string - pattern: "^[0-9]{13}$" - example: "9100010270001" - ApolloPartyV1: + example: "EXW" + createDate: + type: string + format: date-time + example: "2025-11-24T07:24:41.1456919Z" + netTotal: + type: number + example: 0 + validTill: + type: string + format: date-time + example: "0001-01-01T00:00:00Z" + validity: + type: integer + example: 0 + originPort: + $ref: "#/components/schemas/Location" + destinationPort: + $ref: "#/components/schemas/Location" + portOfLoad: + type: string + example: "" + portOfDischarge: + type: string + example: "" + pricingDetail: + $ref: "#/components/schemas/PricingDetailV1" + estimateChargableWeight: + type: number + example: 7 + estimateChargableWeightUnit: + type: string + example: "lb" + chargeDetails: + type: array + items: + $ref: "#/components/schemas/ChargeDetail" + paymentTerm: + $ref: "#/components/schemas/PaymentTerm" + shipmentPartyDetail: + type: array + items: + $ref: "#/components/schemas/ShipmentPartyDetailV1" + shipmentDetails: + $ref: "#/components/schemas/QuoteShipmentDetails" + + Location: type: object - description: Party information (shipper, consignee, or third party). - required: - - city - - countryCode properties: - company: + portCode: type: string - description: Name of the company. - example: Philip - account: + example: "" + portName: type: string - description: Account number associated with the party. - example: "987654321" - address1: + example: "" + serviceType: type: string - description: Primary address line. - example: 12380 MORRIS RD - address2: + example: "" + serviceCenterCode: type: string - description: Secondary address line. - example: Mailroom - address3: + example: "" + serviceRatedOverCode: type: string - description: Last address line. - example: Floor 1 + example: "" + + PricingDetailV1: + type: object + properties: + rateType: + type: string + example: "Market" + rateDescription: + type: string + example: "Applied Market Rates For PA, as published rates (GCNAAF) were resolved for 'AF' charge" + currencyCode: + type: string + example: "USD" + actualTotalPrice: + type: number + example: 535.26 + netTotalPrice: + type: number + example: 535.26 + discountDetail: + $ref: "#/components/schemas/DiscountDetailV1" + + DiscountDetailV1: + type: object + properties: + discount: + type: number + example: 0 + discountPercent: + type: number + example: 0 + eligibleDiscount: + type: number + example: 0 + eligibleDiscountPercent: + type: number + example: 0 + discountAdjustedFor: + type: string + example: "" + discountValidTill: + type: string + example: "" + + ChargeDetail: + type: object + properties: + shipmentPartyType: + type: string + example: "SHPR" + charges: + type: array + items: + $ref: "#/components/schemas/BookChargeV1" + + BookChargeV1: + type: object + properties: + chargeType: + type: string + example: "961" + description: + type: string + example: "NON-CONFORMING CARGO" + chargeAmount: + type: number + example: 245 + currency: + type: string + example: "USD" + originalChargeAmount: + type: string + example: "" + + ShipmentPartyDetailV1: + type: object + properties: + type: + type: string + example: "THRD" + accountNumber: + type: string + example: "708832704" + contactDetail: + $ref: "#/components/schemas/ContactDetail" + address: + $ref: "#/components/schemas/Address" + + Address: + type: object + properties: + companyName1: + type: string + example: "Walmart" + companyName2: + type: string + example: "" + addressLine1: + type: string + example: "7500 CENTURION PARKWAY" + addressLine2: + type: string + example: " " + addressLine3: + type: string + example: "" city: type: string - description: City of the party. - example: Alpharetta - state: + example: "JACKSONVILLE" + stateCode: type: string - description: The state code is required for country codes US or CA - minLength: 2 - maxLength: 2 - pattern: '^[A-Z]{2}' - example: GA + example: "FL" postalCode: type: string - description: Postal code of the party. - example: "30005" + example: "32256" countryCode: - description: The ISO 3166 country or territory code. - $ref: "#/components/schemas/ApolloCountryCodeV1" - serviceCenterCode: type: string - description: Service center code. - examples: - - SDF - - EWR - - ATL - partyCode: + example: "US" + isLoadingDockAvailable: type: string - description: Party code. - example: CID-987654321 - contactName: + example: "" + isResidentialAddress: type: string - description: Name of the contact person. - example: Michael - contactPhone: + example: "" + + QuoteShipmentDetails: + type: object + properties: + insuredValueCurrency: type: string - description: Phone number of the contact person. - example: "999999999" - contactEmail: + example: "" + insuredValue: + type: number + example: 0 + customsValueCurrency: type: string - description: Email address of the contact person. - pattern: '^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$' - example: test@gmail.com - details: - description: Additional details about the party as key-value pairs. - $ref: "#/components/schemas/ApolloCustomArrayV1" - additionalProperties: false - ApolloPickupTotalV1: + example: "" + customsValue: + type: number + example: 0 + commodityName: + type: string + example: "Books" + fclCargoItems: + type: array + items: + $ref: "#/components/schemas/CargoItem" + lclCargoItems: + type: array + items: + $ref: "#/components/schemas/LclCargoItem" + airCargoItems: + type: array + items: + $ref: "#/components/schemas/AirCargoItem" + location: + type: array + items: + $ref: "#/components/schemas/Location" + LclCargoItem: + allOf: + - $ref: "#/components/schemas/CargoItem" + + AirCargoItem: type: object - required: - - shipmentCount - - itemCount - - totalWeight properties: - shipmentCount: - type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 10 - itemCount: + quantity: type: integer - format: int32 - minimum: 1 - minLength: 1 - example: 10 - totalWeight: - type: number - format: double - minimum: 1 - minLength: 1 - example: 10 - additionalProperties: false - ApolloShipmentNumberV1: - type: - - string - - "null" - description: Unique identifier for the shipment. - minLength: 1 - examples: - - "9100010271" - ApolloShipmentPartyV1: - allOf: - - $ref: "#/components/schemas/ApolloShipmentAddressV1" - - type: object - description: Additional shipment party specific fields. All are optional. + example: 1 + weight: + $ref: "#/components/schemas/WeightDetail" + dimensions: + $ref: "#/components/schemas/Dimensions" + #Get Shipment Details API Schemas + ApolloShipmentDetailResponseV1: + type: object + properties: + response: + type: object properties: - account: - type: - - string - - "null" - maxLength : 9 - minLength : 6 - description: The unique UPS Freight Account Number associated with the Party. It's required when the party is the Shipper or Payor - example: 5503YY - serviceCenterCode: - type: - - string - - "null" - maxLength : 5 - description: The service center that is associated with the Party. - example: SDF - contactName: - type: - - string - - "null" - maxLength : 40 - description: The name of the person who can handle the communications related to the Shipment - example: John Doe - contactPhone: - type: - - string - - "null" - maxLength : 25 - description: The phone number of the person who can handle the communications related to the Shipment - example: 678-123-4567 - contactEmail: - type: - - string - - "null" - minLength: 1 - maxLength : 40 - description: The email of the person who can handle the communications related to the Shipment - example: john.doe@acme.com - details: - description: Any additional information related to the party in the format of key value pair - $ref: "#/components/schemas/ApolloCustomArrayV1" - unevaluatedProperties: false - ApolloShipmentAddressV1: + shipmentSummary: + $ref: "#/components/schemas/ShipmentSummary" + required: + - shipmentSummary + required: + - response + additionalProperties: false + ShipmentSummary: + type: object + properties: + shipmentNumber: + type: + - string + - "null" + description: Unique identifier for the shipment. + example: "SHIP12345" + confirmationId: + type: + - string + - "null" + description: Confirmation identifier for the shipment. + example: "374680504" + quoteIdentificationNumber: + type: + - string + - "null" + description: Quote identification number. + example: "200025511" + status: + type: string + description: Status of the shipment. + example: "ShipmentConfirmed" + serviceLine: + type: string + description: Service line associated with the shipment. + example: "LCL" + serviceType: + type: string + enum: + - CAD + - AM + - D2G + - D2 + - DFG + - DF + - CX + - CA + - EC + - PF + - PA + - EL + - SA + description: Type of service being represented. + example: "PF" + serviceGroup: + type: + - string + - "null" + description: Service group associated with the shipment. + movementType: + type: string + enum: + - DTD + - DTP + - PTD + - PTP + description: Movement type of the shipment. + example: "DTD" + movementTypeCode: + type: + - string + - "null" + enum: + - DTD + - DTA + - ATD + - ATA + description: Movement type code of the shipment. + rateType: + type: string + enum: + - Market + - Negotiated + description: Rate type of the shipment. + example: "Market" + transitTime: + type: integer + description: Transit time in minutes. + example: 16 + validTill: + type: + - string + - "null" + format: date-time + description: Date until which the shipment is valid. + example: "2024-12-24T00:00:00Z" + validity: + type: integer + description: Validity period of the shipment in days. + example: 7 + portOfLoad: + type: + - string + - "null" + description: Port of load for the shipment. + example: "DEP01" + portOfDischarge: + type: + - string + - "null" + description: Port of discharge for the shipment. + example: "USP0B" + createdDate: + type: string + format: date-time + description: Date and time when the shipment was created. + example: "2024-12-17T05:19:25.7966667Z" + incoTermType: + type: + - string + - "null" + description: Incoterms type specifying the terms of trade. + example: "DAP" + originPort: + $ref: "#/components/schemas/PortInfo" + destinationPort: + $ref: "#/components/schemas/PortInfo" + paymentTerm: + $ref: "#/components/schemas/PaymentTerm" + partyDetails: + type: array + description: Collection of party details associated with the shipment. + items: + $ref: "#/components/schemas/PartyDetail" + cargoDetails: + $ref: "#/components/schemas/CargoDetails" + pickupDetail: + $ref: "#/components/schemas/PickupDetail" + chargeDetails: + type: array + description: Collection of charge details associated with the shipment. + items: + $ref: "#/components/schemas/ChargeDetailV1" + PartyDetail: type: object - discriminator: - propertyName: operationId - mapping: - orderCreate: '#/components/schemas/ApolloOrderResponseV1' - orderSearch: '#/components/schemas/ApolloOrderSearchResponseV1' - printLabel: '#/components/schemas/ApolloLabelV1' - submitAirShipment: '#/components/schemas/ApolloAirShipmentDataResponseV1' - required: - - address1 - - city - - postalCode - - countryCode properties: - operationId: - description: A string value to track this operation + type: + type: string + description: Type of the party involved in the transaction (e.g., SHPR, CONS, THRD). + example: "SHPR" + accountNumber: type: - string - "null" - enum: - - orderCreate - - orderCancel - - orderSetDate - - orderSearch - - printLabel - - submitAirShipment - - cancelAirShipment - - printAirManifest - - airFreightRating - - getCity - partyCode: + description: Account number associated with the party. + isPayor: + type: boolean + description: Indicates whether the party is designated as the payor. + example: true + contactDetail: + $ref: "#/components/schemas/ContactDetailV1" + address: + $ref: "#/components/schemas/AddressDetail" + ContactDetailV1: + type: object + properties: + name: type: - string - "null" - maxLength : 32 - description: The hashcode generated using the a Party's details, primaririly used to avoid duplicates - example: CID-987654321 - company: + description: Name of the contact person or organization. + emailAddress: type: - string - "null" - maxLength : 40 - description: The name of the company associated with the Shipment/Party - example: Ship To Philip - address1: + description: Email address associated with the contact. + faxNumber: type: - string - "null" - maxLength : 40 - description: The line 1 of the address associated with the Party - example: 45678 MAIN ST - address2: + description: Fax number associated with the contact. + phoneNumber: type: - string - "null" - description: The line 2 of the address associated with the Party - example: Suite 320 - address3: + description: Phone number associated with the contact. + referenceNumber: + type: + - string + - "null" + description: Reference number associated with the contact. + additionalProperties: false + + AddressDetail: + type: object + properties: + companyName1: type: - string - "null" - maxLength : 40 - description: The line 3 of the address associated with the Party - example: Floor 3 + description: First company name associated with the address. + companyName2: + type: + - string + - "null" + description: Second company name associated with the address. + addressLine1: + type: + - string + - "null" + description: First line of the address. + addressLine2: + type: + - string + - "null" + description: Second line of the address. + addressLine3: + type: + - string + - "null" + description: Third line of the address. city: type: - string - "null" - maxLength : 40 - description: The address city associated with the Party - example: Newark - state: + description: City associated with the address. + example: "HAMBURG" + stateCode: type: - string - "null" - minLength: 2 - maxLength : 4 - pattern: ^[A-Z]{2} - description: The ISO 3166-2 state code associated with the Party - example: NJ + description: State code. postalCode: type: - string - "null" - maxLength : 15 - description: The line 2 of the address associated with the Party - example: 07102" + description: Postal code. countryCode: type: - string - "null" - minLength: 2 - maxLength : 4 - description: The ISO 3166 country or territory code associated with the Party - pattern: ^[A-Z]{2} - example: US - ApolloShipperAccountNumberV1: - description: The UPS Freight Account Number that identifies the Shipper - type: - - string - - "null" - minLength: 1 - example: "123456789" - ApolloTimeV1: - type: string - format: time - pattern: '^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$' - example: 09:00:00 - ApolloWeightV1: - type: number - format: decimal - multipleOf: 0.01 - ApolloPatchReplaceReqV1: - type: array - description: The unbounded list of objects to change with their values - minItems: 1 - items: - type: object - required: - - op - - path - - value - properties: - op: - type: - - string - - "null" - enum: - - replace - path: - type: - - string - - "null" - description: the field whose value is to be changed - example: /newDate - value: - type: - - string - - "null" - description: new value to insert into the defined field - example: 2025-07-24 + description: ISO 3166-1 alpha-2 country code (e.g., US, IN, GB). + example: "DE" + companyName: + type: + - string + - "null" + description: Full company name. + fullAddress: + type: + - string + - "null" + description: Full address, including street, city, state, and postal code. + CargoDetails: + type: object + properties: + insuredValueCurrency: + type: string + description: Currency code associated with the insured value. + example: "USD" + insuredValue: + type: number + description: Insured value of the item. + example: 5600 + customsValueCurrency: + type: string + description: Currency code associated with the customs value. + example: "USD" + customsValue: + type: number + description: Customs value of the item. + example: 5600 + commodityName: + type: string + description: Name of the commodity being shipped. + example: "Leather Dressings" + fclCargoItems: + type: array + description: Collection of Full Container Load (FCL) cargo items. + items: + $ref: "#/components/schemas/FclCargoItem" + cargoItems: + type: array + description: Collection of Less-than-Container Load (LCL) cargo items. + items: + $ref: "#/components/schemas/LclCargoItemV1" + + PickupDetail: + type: object + properties: + date: + type: + - string + - "null" + startTime: + type: + - string + - "null" + description: Start time for the pickup. + endTime: + type: + - string + - "null" + description: End time for the pickup. additionalProperties: false - #Common Schemas for newly added APIs - - Charges: + + ChargeDetailV1: + type: object + properties: + shipmentPartyType: + type: string + description: Type of party responsible for the shipment (e.g., SHPR, CONS, THRD). + example: "SHPR" + charges: + type: array + description: Collection of charges associated with the shipment. + items: + $ref: "#/components/schemas/ChargeV2" + required: + - shipmentPartyType + - charges + additionalProperties: false + + ChargeV2: type: object - description: Individual charge information. properties: chargeType: type: string - description: Type of charge. - example: "Freight" + description: Type of charge associated with the transaction. + example: "OF1" description: type: string description: Description of the charge. - example: "Freight Charge" + example: "OCEAN FRT. LCL" chargeAmount: type: number - format: float - description: Amount of the charge. - example: 100.00 + description: Amount to be charged for a transaction. + example: 1153.53 currency: type: string - description: Currency code for the charge. + description: Currency in which the charge amount is denominated. example: "USD" - originalChargeAmount: - type: string - description: Original charge amount as string. - example: "100.00" - required: - - chargeType - - description - - chargeAmount - - currency - - originalChargeAmount - - #/air/ship - ApolloAirShipRequestV1: - type: object - required: [shipper, consignee, shipment] - properties: - shipper: - $ref: '#/components/schemas/PartyDetails' - consignee: - $ref: '#/components/schemas/PartyDetails' - thirdParty: - $ref: '#/components/schemas/PartyDetails' - description: ThirdParty details for the shipment. - nullable: true - type: [object, "null"] - shipment: - $ref: '#/components/schemas/ShipmentDetail' - label: - $ref: '#/components/schemas/LabelRequest' - description: Label formatting options including layout and format (e.g., PDF, ZPL, SVG). - nullable: true - type: [object, "null"] - language: - type: string - description: Language preference for the response. - example: "en" - transactionId: - type: string - description: Unique transaction ID for debugging and tracking. - example: "txn-001" - PartyDetails: + additionalProperties: false + LclCargoItemV1: type: object - required: [account, address1, contactName, contactPhone, contactEmail, company, city, countryCode] properties: - account: - type: string - description: UPS Freight Account Number associated with the party is required when the address is not provided. - example: "123456789" - address1: + quantity: + type: integer + description: Quantity of the LCL cargo item. + example: 11 + packageType: type: string - description: The primary address line. - minLength: 1 - maxLength: 40 - example: "123 Main St" - address2: + description: Type of packaging used for the LCL cargo item. + example: "Pallets" + packageTypeCode: type: string - description: The secondary address line. - maxLength: 40 - example: "Suite 100" - address3: + description: Code representing the type of packaging. + example: "PLT" + weightDetail: + $ref: "#/components/schemas/WeightDetail" + dimensions: + $ref: "#/components/schemas/Dimensions" + required: + - quantity + - packageType + - packageTypeCode + - weightDetail + - dimensions + additionalProperties: false + #Accessorials + ApolloAirUtilityAccessorialsRequestV1: + type: object + required: [shipper, consignee,pickupDateTime,dropOffTime] + properties: + shipper: + $ref: '#/components/schemas/ShipmentPartyDetails' + consignee: + $ref: '#/components/schemas/ShipmentPartyDetails' + serviceCode : + type: + - string + enum: + - AMG + - AM + - D2G + - D2 + - DFG + - DF + - CX + - CA + - EC + - MEXDF + - SAT + - SATG + - GOLDP + - CXD + - CXC + - CXCD + - CAD + - CAC + - CACD + - ECD + - ECC + - ECCD + - EG + - EA + pickupDateTime : type: string - description: The last address line. - maxLength: 40 - example: "" + format: date + description: Accepted format - yyyy-MM-dd, yyyy/MM/dd, MM-dd-yyyy, MM/dd/yyyy format. + pattern: ^\d{4}-\d{2}-\d{2}$ + example: "2025-08-11" + dropOffTime : + description: The RFC 3339 shipment dropoff time. + $ref: "#/components/schemas/ApolloTimeV1" + ShipmentPartyDetails: + type: object + required: [city, countryCode,isResidential] + properties: city: type: string description: City of the address. @@ -5687,497 +9378,585 @@ components: state: type: string description: The state code is required for country codes US or CA. - maxLength: 5 + maxLength : 5 example: "NY" postalCode: type: string description: Postal or ZIP code. - maxLength: 9 - example: "10001" + maxLength: 10 + example: "7702" countryCode: type: string description: Two-letter country code (e.g., US, CA, GB). minLength: 2 maxLength: 2 example: "US" - serviceCenterCode: - type: string - description: ServiceCenterCode of the party. - maxLength: 5 - example: "NYC" - partyCode: - type: string - description: PartyCode of the party. - maxLength: 40 - example: "SHIP123" - company: - type: string - description: CompanyName - The name of the company. - minLength: 1 - maxLength: 35 - example: "Shipper Inc" - contactName: - type: string - description: ContactName - The name of the contact person. - minLength: 1 - maxLength: 40 - example: "John Doe" - contactPhone: + isResidential: type: string - description: ContactPhone - The phone number of the contact person. + description: Indicates if the address is residential ("Y" or "N"). + pattern: "^[YN]$" minLength: 1 - maxLength: 25 - example: "+1-555-1234" - contactEmail: + maxLength: 1 + example: "N" + ApolloAirUtilityValidAccessorialsResponseV1: + type: object + description: Response containing a collection of valid accessorials. + properties: + response: + type: object + description: Response wrapper object. + properties: + accessorials: + type: array + description: List of valid accessorials. + items: + $ref: "#/components/schemas/ApolloAccessorialsResponseDetailsV1" + paymentTerms: + type: array + description: The type of payment term (e.g., Shipper, Consignee, ThridParty). + items: + $ref: "#/components/schemas/PaymentTerm" + nextAvailPUDate: + type: string + format: date + description : Next available pickup date + example : "2026-01-09" + required: + - accessorials + - paymentTerms + - nextAvailPUDate + required: + - response + ApolloAccessorialsResponseDetailsV1: + type: object + properties: + code: type: string - description: Email - The email address of the contact person. - minLength: 1 - maxLength: 40 - pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ - example: "john.doe@shipper.com" - partySectionDetails: + description: Code associated with accessorials. + oneOf: + - title: "CUSTOMS CLEARANCE" + enum: ["CC"] + - title: "CUSTOMS VALUE" + enum: ["CV"] + - title: "DESTINATION DUTIES UNPAID" + enum: ["DDU"] + - title: "DELIVERY" + enum: ["DLV"] + - title: "DECLARED/INSURED VALUE" + enum: ["DV"] + - title: "FREE DOMICILE AVAILABLE" + enum: ["DDP"] + - title: "LIFT GATE" + enum: ["LIFTGT"] + ApolloFullTrackingDetailsResponseV1: + type: object + description: Response object containing comprehensive tracking details for a shipment. + required: + - response + properties: + response: type: object - additionalProperties: - type: string - description: Additional details as key-value pairs. - example: - department: "Logistics" - details: - description: Additional details about the party as key-value pairs. - $ref: "#/components/schemas/ApolloCustomArrayV1" - ShipmentDetail: + description: Response container for tracking details + properties: + primaryInformation: + $ref: '#/components/schemas/PrimaryInformation' + description: Primary information and detailed tracking data for the shipment. + PrimaryInformation: type: object - required: [serviceType, paymentType, pickupDate, items, currency, freightType] + description: Comprehensive primary information about the shipment including all tracking details. properties: + id: + type: string + description: The unique identifier for the shipment. + example: "SHIP123456789" shipmentNumber: type: string - description: Shipment number associated with the request. - example: "SHIP0001" - serviceType: + description: The shipment number assigned to this shipment. + example: "SHIP123456789" + upsFileNumber: type: string - description: Type of the service requested (e.g., AM, AMG, D2, D2G, DF, DFG, CA, EC, CX). - enum: [AM, AMG, D2, D2G, DF, DFG, CA, EC, CX] - example: "AM" - paymentType: + description: The UPS file number associated with the shipment. + example: "FILE123456789012345" + upsOffice: type: string - description: Payment method used for the shipment (e.g., PPD, COL, THD). - enum: [PPD, COL, THD] - example: "PPD" - pickupDate: + description: The UPS office code handling the shipment. + example: "ATL01" + upsDatasource: type: string - format: date - description: Scheduled pickup date in YYYY-MM-DD format. - pattern: ^\d{4}-\d{2}-\d{2}$ - example: "2025-08-11" - readyTime: + description: The data source system from which the shipment information is retrieved. + example: "MAIN" + shipper: type: string - description: Time when the shipment will be ready for pickup (HH:MM in 24-hour format). - pattern: ^([01]\d|2[0-3]):([0-5]\d)$ - example: "09:00" - closeTime: + description: The name of the shipper (party sending the goods). + example: "ABC Company" + destinationConsignee: type: string - description: Time when the shipment location will close (HH:MM in 24-hour format). - pattern: ^([01]\d|2[0-3]):([0-5]\d)$ - example: "17:00" - dropoffTime: + description: The name of the destination consignee (party receiving the goods). + example: "XYZ Corporation" + principal: type: string - description: Time when the shipment will be dropped off (HH:MM in 24-hour format). - pattern: ^([01]\d|2[0-3]):([0-5]\d)$ - example: 16:00 - weight: - type: number - format: decimal - description: Total weight of the shipment. - minimum: 0.1 - maximum: 999.9 - example: 25.5 - freightType: + description: The principal party responsible for the shipment. + example: "ABC Company" + proofOfDelivery: type: string - description: FreightType - This is freight type of the shipment piece. Possible values PALLET, LOOSE. - enum: [PALLET, LOOSE] - example: "PALLET" - isMetric: - type: boolean - description: Boolean value which indicates whether the shipment uses metric. - example: true - description: + description: The name of the person who received the shipment as proof of delivery. + example: "John Smith" + podDateTime: type: string - description: Description of the shipment. - example: "Electronics shipment" - shipperReference: + format: date-time + description: The date and time when the proof of delivery was obtained. + example: "2025-01-10T14:30:00Z" + shipmentType: type: string - description: Reference number provided by the shipper. - example: "REF123" - consigneeReference: + description: The type of shipment (e.g., Air, Ocean). + example: "Air" + shipmentServiceLevel: type: string - description: Reference number provided by the consignee. - example: "CREF456" - currency: + description: The service level for the shipment (e.g., Express, Standard). + example: "Express" + modeOfTransportCode: type: string - description: Currency code (e.g., USD, EUR). - minLength: 3 - maxLength: 3 - example: "USD" - requestPickup: - type: boolean - description: Boolean value which indicates whether a pickup request is included. - example: true - requestBoL: - type: boolean - description: Boolean value which Indicates whether a Bill of Lading (BoL) is requested. - example: false - countryOfManufacture: + description: The code representing the mode of transport. + example: "AIR" + modeOfTransportName: + type: string + description: The name of the mode of transport. + example: "Air Freight" + primaryException: + type: string + description: The primary exception affecting the shipment, if any. + shipmentBookedDateTime: + type: string + format: date-time + description: The date and time when the shipment was booked. + example: "2025-01-01T10:00:00Z" + shipmentCreateDateTime: + type: string + format: date-time + description: The date and time when the shipment was created in the system. + example: "2025-01-01T09:00:00Z" + originalScheduledDeliveryDateTime: + type: string + format: date-time + description: The original scheduled delivery date and time for the shipment. + example: "2025-01-10T12:00:00Z" + latestScheduledDeliveryDateTime: + type: string + format: date-time + description: The latest scheduled delivery date and time for the shipment. + example: "2025-01-10T12:00:00Z" + product: + type: string + description: The product or service type used for the shipment. + example: "UPS Air Freight" + actualDeliveryDateTime: + type: string + format: date-time + description: The actual date and time when the shipment was delivered. + example: "2025-01-10T14:30:00Z" + milestoneStatus: + type: string + description: The current milestone status of the shipment (e.g., In Transit, Delivered). + example: "Delivered" + shipmentLatestStatusDateTime: + type: string + format: date-time + description: The date and time of the latest status update for the shipment. + example: "2025-01-10T14:30:00Z" + lastKnownLocation: + type: string + description: The last known location of the shipment. + example: "Atlanta, GA" + consigneeReferenceNumber: type: array items: - type: string - minLength: 2 - maxLength: 2 - description: List of countries where the goods were manufactured. - example: ["US"] - items: + $ref: '#/components/schemas/CustomerReferenceInfo' + description: List of consignee reference numbers associated with the shipment. + customerPONumber: type: array - minItems: 1 - maxItems: 100 items: - $ref: '#/components/schemas/Item' - details: - description: Additional details about the party as key-value pairs. - $ref: "#/components/schemas/ApolloCustomArrayV1" - Item: - type: object - required: [count, length, width, height, weight] - properties: - description: - type: string - description: The description of the item. - maxLength: 50 - example: "Laptop" - count: - type: integer - description: Number of identical items in the shipment. - minimum: 1 - maximum: 99999 - example: 10 - length: - type: number - format: decimal - description: Length of the shipment item in centimeters. - minimum: 0 - maximum: 999.9 - example: 38.5 - width: - type: number - format: decimal - description: Width of the shipment item in centimeters. - minimum: 0 - maximum: 999.9 - example: 25.0 - height: - type: number - format: decimal - description: Height of the shipment item in centimeters. - minimum: 0.1 - maximum: 999.9 - example: 2.5 - weight: - type: number - format: decimal - description: Weight of the shipment item in kilograms. - minimum: 0 - maximum: 999.9 - example: 2.0 - details: - $ref: "#/components/schemas/ApolloCustomArrayV1" - LabelRequest: - type: object - properties: - layout: - type: string - description: The layout type for the label (e.g., AF-GEMINI, AF-UFH). - example: "AF-GEMINI" - format: - type: string - description: The output format for the label (e.g., PDF, ZPL, SVG). - example: "PDF" - details: - type: object - additionalProperties: - type: string - description: A list of label detail fields and values. - example: - Model_Number: "X" - Model_Year: "2023" - Shipper_ReferenceNo: "SHP2401-A3MC220" - ApolloAirShipResponseV1: + $ref: '#/components/schemas/CustomerReferenceInfo' + description: List of customer purchase order numbers associated with the shipment. + references: + type: array + items: + $ref: '#/components/schemas/Reference' + description: List of various reference numbers associated with the shipment. + shipmentAdditionalInformation: + $ref: '#/components/schemas/AdditionalInformation' + description: Additional information about the shipment including weight, volume, and cargo details. + shipmentOrigin: + $ref: '#/components/schemas/ShipmentAddress' + description: The origin address from where the shipment was picked up. + shipmentDestination: + $ref: '#/components/schemas/ShipmentAddress' + description: The destination address where the shipment is to be delivered. + flightVoyageInformation: + type: array + items: + $ref: '#/components/schemas/FlightVoyageInfo' + description: List of flight or voyage information for the shipment journey. + milestones: + $ref: '#/components/schemas/Milestone' + description: Milestone information tracking the progress of the shipment. + shipmentExceptionDetails: + $ref: '#/components/schemas/ShipmentExceptionDetails' + description: Details about any exceptions that occurred during the shipment. + containerInformation: + type: array + items: + $ref: '#/components/schemas/ContainerInfo' + description: Information about containers or packages used in the shipment. + contactInfo: + type: array + items: + $ref: '#/components/schemas/ContactInfo' + description: Contact information for parties involved in the shipment. + CustomerReferenceInfo: type: object - required: - - response - properties: - response: - type: object - shipmentNumber: + description: Customer reference information for tracking and identification purposes. + properties: + referenceType: type: string - description: The shipment number associated with the response. - example: "SHIP0001" - prqNumber: + description: The type of reference (e.g., PO, Invoice, Customer Reference). + example: "PO" + referenceNumber: type: string - description: The PRQ details associated with the shipment. - example: "PRQ123456" - prqStatus: + description: The reference number value. + example: "PO987654" + Reference: + type: object + description: General reference information associated with the shipment. + properties: + code: type: string - description: The shipment status. - example: "CONFIRMED" - originServiceCenter: + description: The reference code identifier. + example: "REF001" + type: type: string - description: The origin service center code. - example: "NYC" - destinationServiceCenter: + description: The type of reference. + example: "Customer Reference" + number: type: string - description: The destination service center code. - example: "SFO" - paymentType: + description: The reference number value. + example: "CUST123456" + createdDate: type: string - description: The payment type for the shipment. - example: "PPD" - rates: - type: array - items: - $ref: '#/components/schemas/RateDetail' - label: - $ref: '#/components/schemas/LabelResponse' - RateDetail: + format: date-time + description: The date and time when the reference was created. + example: "2025-01-01T09:00:00Z" + AdditionalInformation: type: object + description: Additional shipment information including weight, volume, and cargo details. properties: - serviceType: + shipmentCategory: type: string - description: The type of service. - example: "AM" - guaranteedDelivery: - type: boolean - description: Indicates if delivery is guaranteed. - example: true - deliveryTime: + description: The category or classification of the shipment. + example: "General Cargo" + quantity: type: string - description: The estimated delivery time. - example: "2025-08-12T10:00:00Z" - holdAtAirportTime: + description: The total quantity of items in the shipment. + example: "10" + itemDescription: type: string - description: The hold at airport time. - example: "2025-08-12T12:00:00Z" - totalCharge: - type: number - format: decimal - description: The total charge for the service. - example: 150.75 - currency: + description: Description of the items being shipped. + example: "Electronic Equipment" + incoterms: type: string - description: The currency type. - example: "USD" - billableWeight: - type: number - format: decimal - description: The billable weight. - example: 30.0 - weightUnit: + description: The Incoterms code governing the shipment (e.g., FOB, CIF, DAP). + example: "DAP" + freightPaymentTerm: type: string - description: The Weight unit used. - example: "KG" - dimensionalWeight: - type: number - format: decimal - description: The dimensional weight. - example: 28.0 - minimumBillableWeightApplied: - type: boolean - description: Indicates if the minimum billable weight was applied. - example: false - contractRate: - type: boolean - description: Indicates if the contract rate applies. - example: false - charges: - type: array - items: - $ref: '#/components/schemas/Charges' - LabelResponse: + description: The payment terms for the freight (e.g., Prepaid, Collect). + example: "Prepaid" + actualWeight: + $ref: '#/components/schemas/WeightMeasurement' + description: The actual weight of the shipment. + chargeableWeight: + $ref: '#/components/schemas/WeightMeasurement' + description: The chargeable weight used for pricing calculations. + shipmentVolume: + $ref: '#/components/schemas/VolumeMeasurement' + description: The total volume of the shipment. + WeightMeasurement: type: object + description: Weight measurement including the value and unit of measurement. properties: - format: - type: string - description: The format of the label. - example: "PDF" - layout: + weight: type: string - description: The layout of the label. - example: "4x6" - labelT: + description: The weight value. + example: "500" + uomCode: type: string - description: The label text (Base64 encoded). - example: "Base64EncodedLabelString" - image: + description: The unit of measurement code (e.g., KG, LB). + example: "KG" + uomLabel: type: string - format: byte - description: The label in PDF format (Base64 encoded). - example: "Base64EncodedPDF" - - - - ApolloUtilityAirportDetailResponseV1: + description: The descriptive label for the unit of measurement. + example: "Kilograms" + VolumeMeasurement: type: object - description: Response containing a collection of airport details. + description: Volume measurement including the value and unit of measurement. properties: - response: - type: object - description: Response wrapper object. - properties: - airportDetails: - type: array - description: List of airport details. - items: - $ref: "#/components/schemas/ApolloAirportResponseDetailsV1" - required: - - airportDetails - required: - - response - - ApolloAirportResponseDetailsV1: + volume: + type: string + description: The volume value. + example: "2.5" + uomCode: + type: string + description: The unit of measurement code (e.g., CBM, CFT). + example: "CBM" + uomLabel: + type: string + description: The descriptive label for the unit of measurement. + example: "Cubic Meters" + ShipmentAddress: type: object + description: Address information for shipment origin or destination. properties: + addressLine1: + type: string + description: The first line of the street address. + example: "123 Industrial Blvd" + addressLine2: + type: string + description: The second line of the street address (e.g., suite, building). + example: "Suite 100" city: type: string - description: City where the airport is located. - example: "New York" - airportCode: + description: The city name. + example: "Los Angeles" + stateProvince: type: string - description: Unique code identifying the airport. - example: "JFK" + description: The state or province code. + example: "CA" postalCode: type: string - description: Postal code associated with the airport's location. - example: "11430" - stateProvince: + description: The postal or ZIP code. + example: "90001" + country: type: string - description: State or province of the airport's location. - example: "NY" - - CountryCodeResponseV1: - type: object - properties: - countries: - type: array - description: List of countries - items: - $ref: "#/components/schemas/CountryCodeV1" - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: + description: The country code (ISO format). + example: "US" + unloc: type: string - CountryCodeV1: + description: The UN Location Code (UNLOC) for the address. + example: "USLAX" + FlightVoyageInfo: type: object + description: Information about a flight or voyage leg in the shipment journey. properties: - countryCode: + leg: type: string - description: ISO 3166-1 alpha-2 country code - countryName: + description: The leg number in the journey sequence. + example: "1" + displayDepartureLocation: type: string - description: Name of the country - - PaymentTermInfoV1: - type: object - properties: - code: + description: The display name of the departure location. + example: "Los Angeles (LAX)" + displayArrivalLocation: type: string - description: Payment type code - type: + description: The display name of the arrival location. + example: "Atlanta (ATL)" + carrierCode: type: string - description: Type of the payment term - description: + description: The carrier code (airline or shipping line). + example: "UA" + carrierName: type: string - description: Description of the payment term - incoTermCode: + description: The full name of the carrier. + example: "United Airlines" + vessel: type: string - description: Incoterm code - movementTypeCode: + description: The name or type of vessel/aircraft. + example: "Boeing 777" + flightVoyageNumber: type: string - description: Movement type code - serviceGroupName: + description: The flight or voyage number. + example: "UA1234" + estimateDepartureDateTime: type: string - description: Name of the service group - serviceLine: + format: date-time + description: The estimated departure date and time. + example: "2025-01-02T08:00:00Z" + confirmedDepartureDateTime: type: string - description: Service line code - - PaymentTypeResponseV1: + format: date-time + description: The confirmed departure date and time. + example: "2025-01-02T08:15:00Z" + estimatedArrivalDateTime: + type: string + format: date-time + description: The estimated arrival date and time. + example: "2025-01-02T16:00:00Z" + confirmedArrivalDateTime: + type: string + format: date-time + description: The confirmed arrival date and time. + example: "2025-01-02T15:45:00Z" + masterBill: + type: string + description: The master bill of lading or airway bill number. + example: "MASTER123456" + Milestone: type: object + description: Container for shipment milestone information. properties: - shipper: - $ref: "#/components/schemas/PaymentTermInfoV1" - consignee: - $ref: "#/components/schemas/PaymentTermInfoV1" - thirdParty: - $ref: "#/components/schemas/PaymentTermInfoV1" - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: + shipmentMilestones: + type: array + items: + $ref: '#/components/schemas/ShipmentMilestone' + description: List of milestones achieved during the shipment journey. + ShipmentMilestone: + type: object + description: Individual milestone in the shipment journey. + properties: + id: type: string - - CurrenciesResponseV1: + description: The unique identifier for the milestone. + example: "M001" + label: + type: string + description: The descriptive label for the milestone (e.g., Picked Up, In Transit, Delivered). + example: "Picked Up" + milestoneCompletionDateTime: + type: string + format: date-time + description: The date and time when the milestone was completed. + example: "2025-01-01T14:00:00Z" + milestoneUNLOC: + type: string + description: The UN Location Code where the milestone occurred. + example: "USLAX" + ShipmentExceptionDetails: type: object + description: Details about exceptions that occurred during the shipment. properties: - currencies: + exceptionCount: + type: string + description: The total count of exceptions for the shipment. + example: "0" + exceptionList: type: array - description: List of currencies items: - $ref: "#/components/schemas/CurrencyDataV1" - warnings: - $ref: "#/components/schemas/ApolloWarningArrayV1" - message: + $ref: '#/components/schemas/ShipmentException' + description: List of exception details. + ShipmentException: + type: object + description: Individual exception that occurred during the shipment. + properties: + exceptionType: type: string - - CurrencyDataV1: - type: object + description: The type or category of the exception. + example: "Delay" + exceptionReason: + type: string + description: The reason for the exception. + example: "Weather conditions" + exceptionDateTime: + type: string + format: date-time + description: The date and time when the exception occurred. + example: "2025-01-05T10:00:00Z" + exceptionResolvedDateTime: + type: string + format: date-time + description: The date and time when the exception was resolved, if applicable. + example: "2025-01-05T14:00:00Z" + isException: + type: string + description: Flag indicating whether this is an active exception (true/false). + example: "false" + ContainerInfo: + type: object + description: Information about a container or package in the shipment. properties: - currencyCode: + containerNumber: type: string - description: Currency code - currencyName: + description: The unique container or package number. + example: "CONT123456" + containerType: type: string - description: Currency name - currencySymbol: + description: The type of container (e.g., Pallet, Box, Crate). + example: "Pallet" + containerDescription: type: string - description: Currency symbol - - #/utility/servicetypes/search - ServiceTypeSearchResponseV1: + description: A description of the container. + example: "Standard Air Pallet" + seal: + type: string + description: The seal number applied to the container for security. + example: "SEAL789" + quantity: + type: string + description: The quantity of items in the container. + example: "10" + containerWeight: + $ref: '#/components/schemas/WeightMeasurement' + description: The weight of the container. + containerVolume: + $ref: '#/components/schemas/VolumeMeasurement' + description: The volume of the container. + ContactInfo: type: object - description: Response containing service types. + description: Contact information for parties involved in the shipment. properties: - response: - type: object - description: Response containing a list of serviceTypes. - properties: - serviceTypes: - type: array - description: List of available service types. - items: - $ref: "#/components/schemas/ServiceTypeInfo" - required: - - serviceTypes - required: - - response - - ServiceTypeInfo: + role: + type: string + description: The role code of the contact (e.g., SHPR for Shipper, CONS for Consignee). + example: "SHPR" + roleName: + type: string + description: The descriptive name of the role. + example: "Shipper" + account: + type: string + description: The account number associated with the contact. + example: "123456" + businessId: + type: string + description: The business identifier for the contact. + example: "BUS123456" + name: + type: string + description: The name of the contact person or company. + example: "ABC Company" + phone: + type: string + description: The phone number for the contact. + example: "+1-555-1234" + attention: + type: string + description: The attention line or department name. + example: "Shipping Department" + address: + $ref: '#/components/schemas/ContactAddress' + description: The address information for the contact. + ContactAddress: type: object - description: Service type information. + description: Address information for a contact. properties: - code: + street: type: string - description: Code for the service type. - example: "AIR" - description: + description: The street address. + example: "123 Industrial Blvd" + city: type: string - description: Description of the service type. - example: "Air Freight" - required: - - code - - description + description: The city name. + example: "Los Angeles" + stateProvince: + type: string + description: The state or province code. + example: "CA" + postalCode: + type: string + description: The postal or ZIP code. + example: "90001" + country: + type: string + description: The country code (ISO format). + example: "US" + unloc: + type: string + description: The UN Location Code (UNLOC) for the address. + example: "USLAX" From 27fb4c9903407fc3ec47659a7f4dceef135e9b21 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 30 Jan 2026 12:44:00 -0500 Subject: [PATCH 50/89] Update --- Transportation.yaml | 1304 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1304 insertions(+) create mode 100644 Transportation.yaml diff --git a/Transportation.yaml b/Transportation.yaml new file mode 100644 index 0000000..b2cb27b --- /dev/null +++ b/Transportation.yaml @@ -0,0 +1,1304 @@ +openapi: 3.1.0 +info: + title: "UPS Partner’s Transportation Data Ingestion API" + description: | + ## Purpose + This API is used to ingest the partner's(UPS SCS customers) shipments data into Symphony. This data is processed and made visible on Symphony for tracking. + API to post transportation order data for point to point shipments to allow for a near real time visibility. API supports only standalone transactions and does not support data aggregations or orchestration with different source systems. + version: "1.0" +tags: + - name: "Transportation" + description: "Partner Publisher API" +servers: + - url: https:onlinetools.ups.com/api/transaction-visibility-dashboard/v1 + description: This is the Symphony server URL for partner publisher api. + +paths: + "/Ingest": + post: + summary: Ingest partner's shipments data in bulk + description: "This API is used to ingest the partner's shipments data into Symphony." + operationId: SC360_PublisherAPI_Ingest + security: + - OAuth2ClientCredentialsWithAssertion: [] + x-slo: + availability: "99%" + response_time: + - percentile: 99 + value: "900 ms" + - percentile: 95 + value: "750 ms" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360InterfaceSC360IngestRequest" + examples: + sampleTransportationOrderRequest: + value: + request: + docFlow: 'Inbound' + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + docVer: 1.0.0.0 + orderDetails: + - customerAccountNumber: DEMO + orderNumber: LD123437 + customerPONumber: PO44859478 + orderPlacedDate: '2023-07-09T11:07:38.446' + shipmentDetails: + - activityInformation: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + activityID: Delivered + activityLocation: + city: Houston + country: US + latitude: "+29.749907" + longitude: "-95.358421" + postalCode: '75847' + stateProvince: TX + deliveryInformation: + actualDeliveryDateTime: '2023-08-03 10:13:00.000' + actualDeliveryDateTimegmtOffset: "-04:00" + podSignedBy: John + podSignedOn: '2023-08-03 10:13:00.000' + description: delivered + localDateTime: '2019-08-24T14:15:22Z' + sensorEvent: true + type: activity + actualPickupDateTime: '2019-08-24T14:15:22Z' + billingInformation: + billingTermCode: consignee + billingTermDescription: to be paid by consignee + carrier: + carrierCode: convergence + carrierName: Sample + earliestDeliveryDateTime: '2019-08-24T14:15:22Z' + internationalShipment: + harmonizedCommodityCode: + shipmentExportCountryCode: + specialInstructions: + latestDeliveryDateTime: '2019-08-24T14:15:22Z' + leadShipmentNumber: SN4765746545 + partyDetails: + - city: CLEVELAND + countryCode: US + stateCode: 'GA' + type: Shipper + - city: Atlanta + countryCode: US + stateCode: 'GA' + type: Consignee + rescheduledDeliveryDateTime: '2019-08-24T14:15:22Z' + scheduledDeliveryDateTime: '2019-08-24T14:15:22Z' + scheduledPickupDateTime: '2019-08-24T14:15:22Z' + sensorData: + gps: + city: Houston + country: US + latitude: "+29.749907" + longitude: "-95.358421" + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + humidityLevel: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + humidity: '40' + humidityUOM: g/m3 + localDateTime: + lightStrength: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + light: '100' + lightUOM: lux + localDateTime: + shockForce: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + shock: '10' + shockUOM: g + temperature: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + temperatureInfo: '10' + temperatureUOM: C + service: + carrierServiceCode: Standard + carrierServiceDescription: Standard + handlingCode: + handlingDescription: + saturdayDeliveryFlag: Y + serviceCode: Ground + serviceDescription: Ground + shipUnits: + - dimensionWeight: '100' + dimensionWeightUOM: kg + height: '2.0' + heightUOM: m + itemDesciption: medical equipment + length: '5.0' + lengthUOM: m + weight: '50' + weightUOM: kg + width: '5.0' + widthUOM: m + shipmentQuantity: 100 + volume: '50.0' + volumeUOM: dm3 + shipmentDescription: Vaccination + shipmentNumber: SN1658566 + shipmentReferences: + - referenceType: Order + referenceValue: SO67890 + specialInformation: + hazmatCategoryCode: Explosives + hazmatCategoryDescription: Explosives + hazmatFlag: 'Y' + temperatureCondition: cold + shipmentPlacedDate: '2019-08-24T14:15:22Z' + carrierShipmentNumber: + - 1Z7Y47110445061158 + - 1Z0445067Y47111148 + shipmentUniqueKey: DEMO_SN1658566_20230709 + shipmentBookedDate: '2019-08-24T14:15:22Z' + exceptionInformation: + exceptionType: Damaged + reasonCode: Damaged due to weather + reasonDescription: Damaged due to weather + resolutionCode: Damaged + resolutionDescription: + statusCode: + statusDescription: Damaged delivery + exceptionCreatedDate: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmt: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmtOffset: "-04:00" + originalDocId: 2767bc53-060c-46d7-bc66-739a09216b35 + sourceSystem: PartnerA + apiVersion: v1.0 + + + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360ResponseListServiceResponse" + examples: + sampleTransportationOrderSuccessResponse: + value: + errors: + - code: + message: + source: + isCompleted: true + isFaulted: false + result: + - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 + orderNumber: LD123437 + shipmentNumber: SN1658566 + shipmentUniquekey: DEMO_SN1658566_20230709 + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + isCompleted: true + '207': + description: Multi-Status Success Response + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360ResponseListServiceResponse" + examples: + sampleTransportationOrderSuccessResponse: + value: + errors: + - code: + message: + source: + isCompleted: true + isFaulted: false + result: + - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 + orderNumber: LD123437 + shipmentNumber: SN1658566 + shipmentUniquekey: DEMO_SN1658566_20230709 + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + isCompleted: true + - messageId: a9ea93db-1e51-492f-83c4-d864c95db056 + orderNumber: LD123438 + shipmentNumber: SN1658567 + shipmentUniquekey: DEMO_SN1658566_20230710 + docId: 62551ca8-36c8-4655-84f1-1459440ee9ee + docType: Order + isCompleted: false + '400': + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '400' + message: One or more required property is not provided value + source: shipmentUniqueKey + isCompleted: true + isFaulted: true + result: + '401': + description: Authorization Error + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '401' + message: Unauthorized + source: + isCompleted: true + isFaulted: true + result: + '500': + description: Server Error + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '500' + message: Unexpected server error has occurred. Please try again after some time. + source: + isCompleted: true + isFaulted: true + result: +components: + schemas: + ActivityInformation: + type: object + description: Use this to provide info about activities and milestones updates for the shipment. + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2023-07-09T11:07:38.446' + gmtOffset: + minLength: 1 + maxLength: 20 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + activityID: + description: Unique identifier for the activity + minLength: 1 + maxLength: 128 + type: [string, "null"] + example: Delivered + activityLocation: + description: Location details of the activity + "$ref": "#/components/schemas/ActivityLocation" + activitySubType: + description: Optional field used to specify additional details for the activity + minLength: 1 + maxLength: 250 + type: [string, "null"] + example: OnTime + activitySubTypeDescription: + description: Field used to specify additional details for the activity sub type + minLength: 1 + maxLength: 250 + type: [string, "null"] + deliveryInformation: + description: This field is used to capture any details about package delivery + "$ref": "#/components/schemas/DeliveryInformation" + description: + minLength: 1 + maxLength: 250 + type: string + description: activity description + example: Package delivered to consignee + localDateTime: + minLength: 1 + maxLength: 100 + type: string + format: date-time + sensorEvent: + description: Use this flag to specify if this activity is a result of sensor event + type: [boolean, "null"] + type: + description: This field is used to specify the type of activity or event + minLength: 1 + maxLength: 25 + type: string + additionalProperties: true + ActivityLocation: + type: object + properties: + city: + description: City name where the activity generated + minLength: 1 + maxLength: 512 + type: string + example: Atlanta + country: + description: Country name where the activity generated + minLength: 1 + maxLength: 512 + type: string + example: United States Of America + latitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Latitude + example: "+29.749907" + longitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Longitude + example: "-95.358421" + postalCode: + minLength: 1 + maxLength: 25 + type: [string, "null"] + stateProvince: + minLength: 1 + maxLength: 512 + type: [string, "null"] + example: "GA" + additionalProperties: false + BillingInformation: + type: object + description: Use this field to specify whom the shipment is charged to and descriptions for billing code + properties: + billingTermCode: + description: Use this field to specify whom the shipment is charged to (consignee, shipper, third party) + minLength: 1 + maxLength: 10 + type: [string, "null"] + example: ThirdParty + billingTermDescription: + description: Descriptions for billing code + minLength: 1 + maxLength: 1000 + type: [string, "null"] + example: Paid by third party + additionalProperties: false + Carrier: + type: object + description: Use this field to provide info about carrier used for shipment + properties: + carrierCode: + description: Carrier code of carrier used for shipment + minLength: 1 + maxLength: 50 + type: [string, "null"] + example: UGFF + carrierName: + minLength: 1 + maxLength: 255 + type: [string, "null"] + carrierType: + description: Carrier type of carrier used for shipment + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Freight + additionalProperties: false + DeliveryInformation: + type: object + description: This field is used to capture any details about package delivery + properties: + actualDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2023-07-09T11:07:38.446' + actualDeliveryDateTimegmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: actual delivery datetime gmt offset + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + podSignatureImage: + minLength: 1 + type: [string, "null"] + format: base64encodedstring + podSignatureText: + minLength: 1 + type: [string, "null"] + podSignedBy: + minLength: 1 + maxLength: 500 + type: [string, "null"] + example: "John" + podSignedOn: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + Error: + type: object + properties: + code: + minLength: 1 + maxLength: 500 + type: [string, "null"] + message: + minLength: 1 + maxLength: 500 + type: [string, "null"] + source: + description: Source method name from where the exception is generated + minLength: 1 + maxLength: 500 + type: [string, "null"] + additionalProperties: false + ExceptionInformation: + type: object + description: This is used to provide additional details about the package delivery exception + properties: + exceptionType: + description: This field is used to provide type of exception + minLength: 1 + maxLength: 255 + type: string + example: Damaged + reasonCode: + description: This field is used to provide reason code of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Weather + reasonDescription: + description: This field is used to provide reason description of exception + minLength: 1 + maxLength: 2000 + type: [string, "null"] + example: Hot weather + resolutionCode: + description: This field is used to provide resolution code of exception + minLength: 1 + maxLength: 255 + type: string + example: Freezer + resolutionDescription: + description: This field is used to provide resolution description of exception + minLength: 1 + maxLength: 2000 + type: [string, "null"] + example: Freezer will be used for vaccines + statusCode: + description: This field is used to provide status code of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Controllable + statusDescription: + description: This field is used to provide status description of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Controllable + exceptionCreatedDate: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmt: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + exceptionCreatedDateGmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + additionalProperties: false + Gps: + type: object + description: Use this field for shipment tracking + properties: + city: + description: City name where the shipment is currently present + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: Atlanta + country: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Country name where the shipment is currently present + example: United States Of America + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + latitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Latitude + example: "+29.749907" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + longitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Longitude + example: "-95.358421" + additionalProperties: false + HumidityLevel: + type: object + description: Use this field to provide information about the shipment humidity conditions + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + humidity: + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "40" + humidityUOM: + description: Humidity Unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: g/m3 + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + InternationalShipment: + description: Use this field for international shipment info like country and commodity code + type: object + properties: + harmonizedCommodityCode: + description: The international commodity or harmonized code that represents the commodity contained in the invoice line + minLength: 1 + maxLength: 50 + type: [string, "null"] + example: "0701.10" + shipmentExportCountryCode: + description: Country Code of shipment export + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: US + specialInstructions: + description: Any international special instructions required + minLength: 1 + type: [string, "null"] + additionalProperties: false + LightStrength: + description: Light sensor data + type: object + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + light: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Light sensor + example: "20" + lightUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + enum: + - lux + - candles + - lumens + - footcandles + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + ObjectServiceResponse: + description: Service response object containgin details if the shipments were processed successfully or not. + type: object + properties: + errors: + type: [array, "null"] + items: + "$ref": "#/components/schemas/Error" + isCompleted: + description: This field denotes if the request was processed successfully or not + type: boolean + isFaulted: + description: This field denotes if there is any error while precessing the shipments + type: boolean + result: + description: List of shipments received in request with the status if they were processed successfully or not + type: [object, "null"] + additionalProperties: false + OrderDetails: + required: + - customerAccountNumber + - shipmentDetails + type: object + description: Use this section to provide/map info about the order (ex load, shipment etc) + properties: + customerAccountNumber: + minLength: 1 + maxLength: 100 + type: string + pattern: ^[a-zA-Z0-9_]*$ + orderNumber: + minLength: 1 + maxLength: 100 + type: [string, "null"] + customerPONumber: + minLength: 1 + type: [string, "null"] + description: Customer Purchase Order Number + example: "SO1023674" + orderPlacedDate: + minLength: 1 + maxLength: 100 + type: string + format: date-time + example: '2023-07-09T11:07:38.446' + shipmentDetails: + type: array + description: Use this section to provide information about the shipment + maxItems: 500 + items: + "$ref": "#/components/schemas/ShipmentDetail" + additionalProperties: false + PartyDetail: + description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc. + type: object + properties: + city: + minLength: 1 + maxLength: 512 + type: string + description: Party(Shipper, Consignee, etc) city name + example: Atlanta + countryCode: + minLength: 1 + maxLength: 50 + type: string + description: Party(Shipper, Consignee, etc) Country code + example: US + stateCode: + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "GA" + type: + minLength: 1 + maxLength: 10 + type: string + enum: + - Shipper + - Consignee + additionalProperties: false + SC360Interface: + description: Supply chain 360 interface + required: + - docType + - orderDetails + - sourceSystem + type: object + properties: + sbMessageId: + description: Service Bus message id + minLength: 1 + type: [string, "null"] + example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" + docFlow: + minLength: 1 + maxLength: 25 + type: string + description: Field for publishers to populate about the document flow type + enum: + - Inbound + - Outbound + docId: + minLength: 16 + maxLength: 50 + type: string + description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. + docTime: + minLength: 1 + maxLength: 100 + type: string + description: Current Date/Time when message is generated in UTC format + format: date-time + docType: + minLength: 1 + maxLength: 25 + type: string + enum: + - OrderStatus + - Order + docVer: + minLength: 1 + maxLength: 10 + type: string + description: Document version. Current version is 1.0 + transactionType: + minLength: 1 + type: [string, "null"] + orderDetails: + type: array + maxItems: 500 + items: + "$ref": "#/components/schemas/OrderDetails" + originalDocId: + minLength: 1 + maxLength: 50 + type: [string, "null"] + description: Unique Identifier for JSON message at the publisher side. Optional field for message publishers to populate + sourceSystem: + minLength: 1 + maxLength: 50 + type: string + description: source system name + example: "BOMI" + partnerId: + minLength: 1 + type: [string, "null"] + additionalProperties: false + SC360InterfaceSC360IngestRequest: + description: Supply chain 360 interface ingest request + required: + - apiVersion + - request + type: object + properties: + request: + "$ref": "#/components/schemas/SC360Interface" + apiVersion: + minLength: 1 + type: string + enum: + - v1.0 + additionalProperties: false + SC360Response: + description: Supply chain 360 response + required: + - docId + - docType + - messageId + - orderNumber + - shipmentNumber + - shipmentUniquekey + type: object + properties: + messageId: + description: Service bus message id for a shipment + minLength: 1 + type: string + example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" + orderNumber: + description: Unique identifier for the order/load. An order could have multiple shipments. + minLength: 1 + type: string + example: LD123437 + shipmentNumber: + minLength: 1 + type: string + description: Unique identifier of a shipment + example: SN12345678 + shipmentUniquekey: + minLength: 1 + type: string + description: shipmentUniqueKey is used to uniquely identify a shipment + example: BOMI_SN1658566_20230709 + docId: + minLength: 1 + type: string + description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. + example: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: + minLength: 1 + type: string + enum: + - OrderStatus + - Order + isCompleted: + type: boolean + additionalProperties: false + SC360ResponseListServiceResponse: + description: Supply chain 360 response list of process shipments + type: object + properties: + errors: + type: [array, "null"] + items: + "$ref": "#/components/schemas/Error" + isCompleted: + description: This field denotes if the request was processed successfully or not + type: boolean + isFaulted: + description: This field denotes if there is any error while precessing the shipments + type: boolean + result: + description: List of shipments received in request with the status if they were processed successfully or not + type: [array, "null"] + items: + "$ref": "#/components/schemas/SC360Response" + additionalProperties: false + SensorData: + type: object + description: This section is used for capturing sensor level data for the package when the sensor event flag is true + properties: + gps: + "$ref": "#/components/schemas/Gps" + humidityLevel: + "$ref": "#/components/schemas/HumidityLevel" + lightStrength: + "$ref": "#/components/schemas/LightStrength" + shockForce: + "$ref": "#/components/schemas/ShockForce" + temperature: + "$ref": "#/components/schemas/Temperature" + additionalProperties: false + Service: + type: object + description: Service information like service code (ex ground, overnight, international and descriptions) + properties: + carrierServiceCode: + description: Use this field to specify the carrier service level if different than service level + minLength: 1 + maxLength: 255 + type: string + example: Standard + carrierServiceDescription: + description: Description for carrier service level + minLength: 1 + type: [string, "null"] + example: Standard + handlingCode: + description: Shipment package handling instructions code + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Fragile + handlingDescription: + description: Shipment package handling instructions description + minLength: 1 + type: [string, "null"] + example: Fragile content, handle with care + saturdayDeliveryFlag: + minLength: 1 + maxLength: 1 + type: [string, "null"] + enum: + - Y + - N + serviceCode: + description: Code of service level for the shipment + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: GND + serviceDescription: + description: Description for the level of service + minLength: 1 + type: [string, "null"] + example: Ground + additionalProperties: false + ShipUnit: + description: List of shipping units like items, length, width, height, etc + type: object + properties: + dimensionWeight: + description: Shipment Unit Dimensional Weight. This is the estimated weight of the package based on its dimensions. + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "200.00" + dimensionWeightUOM: + description: Dimensional weight unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: kg/dm3 + height: + description: Height of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + heightUOM: + description: Height unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + itemDesciption: + description: Shipment unit items description + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: medical equipments + length: + description: Length of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + lengthUOM: + description: Length unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + weight: + description: Weight of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "20" + weightUOM: + description: Weight unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: kg + width: + description: Widht of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + widthUOM: + description: Width unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + shipmentQuantity: + description: Quantity of items in shipment unit + type: [integer, "null"] + format: int32 + example: 20 + volume: + description: Volume of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "50.0" + volumeUOM: + description: Volume unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: dm3 + additionalProperties: false + ShipmentDetail: + required: + - shipmentNumber + - shipmentPlacedDate + - shipmentUniqueKey + type: object + properties: + activityInformation: + description: Use this to provide info about activities and milestones updates for the shipment. + "$ref": "#/components/schemas/ActivityInformation" + actualPickupDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + billingInformation: + description: Use this field to specify whom the shipment is charged to and descriptions for billing code + "$ref": "#/components/schemas/BillingInformation" + carrier: + description: Use this field to provide info about carrier used for shipment + "$ref": "#/components/schemas/Carrier" + collectOnDeliveryAmount: + minLength: 1 + maxLength: 225 + type: [string, "null"] + collectOnDeliveryCurrency: + minLength: 1 + maxLength: 200 + type: [string, "null"] + description: Currency code of the amount received on delivery + earliestDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + internationalShipment: + "$ref": "#/components/schemas/InternationalShipment" + latestDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + leadShipmentNumber: + minLength: 1 + maxLength: 100 + type: [string, "null"] + description: Use this field to provide key information for the lead shipment in case there are multiple packages in a shipment + partyDetails: + type: [array, "null"] + description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc + items: + "$ref": "#/components/schemas/PartyDetail" + rescheduledDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + scheduledDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + scheduledPickupDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + sensorData: + description: This section is used for capturing sensor level data for the package + "$ref": "#/components/schemas/SensorData" + service: + "$ref": "#/components/schemas/Service" + shipUnits: + type: [array, "null"] + description: List of shipping units like number of items, length, width, height, + items: + "$ref": "#/components/schemas/ShipUnit" + shipmentDescription: + minLength: 1 + maxLength: 1000 + type: [string, "null"] + description: Shipment contents description text + example: fragile material + shipmentNumber: + minLength: 1 + maxLength: 100 + type: string + description: Unique identifier of a shipment + example: SN12345678 + shipmentReferences: + type: [array, "null"] + description: List of reference information about the package + items: + "$ref": "#/components/schemas/ShipmentReference" + specialInformation: + description: Provide any special information about shipment like Hazardous material + "$ref": "#/components/schemas/SpecialInformation" + temperatureCondition: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature condition + example: "Amber" + shipmentPlacedDate: + type: string + format: date-time + carrierShipmentNumber: + type: [array, "null"] + items: + type: string + shipmentUniqueKey: + minLength: 1 + maxLength: 100 + type: string + description: shipmentUniqueKey is used to uniquely identify a shipment + shipmentBookedDate: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + exceptionInformation: + description: This is used to provide additional details about the package delivery exception + "$ref": "#/components/schemas/ExceptionInformation" + additionalProperties: false + ShipmentReference: + type: object + description: List of reference information about the package + properties: + referenceCode: + minLength: 1 + maxLength: 50 + type: [string, "null"] + description: Code that identifies the reference value + example: Order + referenceType: + minLength: 1 + maxLength: 50 + type: string + description: This field is used to specify the type of reference field + example: shipment + referenceValue: + minLength: 1 + maxLength: 255 + type: string + description: Reference value + example: PO12345 + additionalProperties: false + ShockForce: + type: object + description: Has shipment been dropped or otherwise exposed to an impact force that exceeds a predetermined level + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + shock: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Shipment has been dropped or otherwise exposed to an impact force that exceeds a predetermined level + example: "20" + shockUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Shock Unit of measurement + example: "g's" + additionalProperties: false + SpecialInformation: + type: object + description: Provide any special information about shipment like Hazardous material + properties: + hazmatCategoryCode: + minLength: 1 + maxLength: 255 + type: [string, "null"] + description: Hazardous material category code + example: Explosives + hazmatCategoryDescription: + minLength: 1 + maxLength: 1000 + type: [string, "null"] + description: Hazardous material category description + example: Explosives + hazmatFlag: + minLength: 1 + maxLength: 1 + type: [string, "null"] + enum: + - Y + - N + additionalProperties: false + Temperature: + type: object + description: Temperature information of the shipment + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + temperatureInfo: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature value of the container + example: "10" + temperatureUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature unit of measurement + example: "C" + enum: + - C + - F + additionalProperties: false + securitySchemes: + OAuth2ClientCredentialsWithAssertion: + type: oauth2 + description: | + This API uses OAuth 2.0 with mutual TLS for client authentication. + The client must include a client assertion signed with a certificate in the token request to token endpoint + client_assertion_type: urn:ietf:params:oauth:client-assertion-type:jwt-bearer + flows: + clientCredentials: + tokenUrl: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token + scopes: {} +security: +- OAuth2ClientCredentialsWithAssertion: [] + From 9aea47c7d32bde71712e046b99aca2261e06c3e9 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 30 Jan 2026 14:01:48 -0500 Subject: [PATCH 51/89] Correct Fix formatting issues in Transportation.yaml and update Ingest path. --- Transportation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Transportation.yaml b/Transportation.yaml index b2cb27b..f70b37c 100644 --- a/Transportation.yaml +++ b/Transportation.yaml @@ -14,7 +14,7 @@ servers: description: This is the Symphony server URL for partner publisher api. paths: - "/Ingest": + /Ingest: post: summary: Ingest partner's shipments data in bulk description: "This API is used to ingest the partner's shipments data into Symphony." From 11cbc9b8620dc5bf7b8114d0841fa6d097625e79 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 30 Jan 2026 14:04:31 -0500 Subject: [PATCH 52/89] Change Updated the endpoint path from '/Ingest' to '/ingest' for consistency. --- Transportation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Transportation.yaml b/Transportation.yaml index f70b37c..28e1da7 100644 --- a/Transportation.yaml +++ b/Transportation.yaml @@ -14,7 +14,7 @@ servers: description: This is the Symphony server URL for partner publisher api. paths: - /Ingest: + /ingest: post: summary: Ingest partner's shipments data in bulk description: "This API is used to ingest the partner's shipments data into Symphony." From d005d252180e4a0ab2876e63a33b7c693451a572 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Fri, 30 Jan 2026 14:15:49 -0500 Subject: [PATCH 53/89] Update Updated endpoint path from '/ingest' to '/Ingest' and added tags. --- Transportation.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Transportation.yaml b/Transportation.yaml index 28e1da7..da955a3 100644 --- a/Transportation.yaml +++ b/Transportation.yaml @@ -14,11 +14,13 @@ servers: description: This is the Symphony server URL for partner publisher api. paths: - /ingest: + "/Ingest": post: summary: Ingest partner's shipments data in bulk description: "This API is used to ingest the partner's shipments data into Symphony." operationId: SC360_PublisherAPI_Ingest + tags: + - Transportation security: - OAuth2ClientCredentialsWithAssertion: [] x-slo: From a4e4f29cd1e9693b6bc7664a6d1de2053de0bb41 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 2 Feb 2026 12:58:32 -0500 Subject: [PATCH 54/89] Update --- Tracking.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Tracking.yaml b/Tracking.yaml index 61ed0c6..403f93c 100644 --- a/Tracking.yaml +++ b/Tracking.yaml @@ -242,7 +242,7 @@ paths: deprecated: false "/track/v1/shipment/details/{inquiryNumber}": get: - summary: Track each pacakge in shipment + summary: Track each Package in shipment tags: - Tracking security: @@ -914,3 +914,4 @@ components: type: string description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. ''KGS'' - kilograms.' + From 745798efa79a6837f26dda2005998253807873eb Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 2 Feb 2026 12:59:36 -0500 Subject: [PATCH 55/89] Update --- Tracking-Ready.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Tracking-Ready.yaml b/Tracking-Ready.yaml index 9aca9a7..6c5216b 100644 --- a/Tracking-Ready.yaml +++ b/Tracking-Ready.yaml @@ -248,7 +248,7 @@ paths: deprecated: false "/track/v1/shipment/details/{inquiryNumber}": get: - summary: Track each pacakge in shipment + summary: Track each Package in shipment tags: - Tracking security: @@ -920,3 +920,4 @@ components: type: string description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. ''KGS'' - kilograms.' + From 0cd2e7185d5c8e502fd3c0d118fdcd3a66fef43d Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 2 Feb 2026 13:04:04 -0500 Subject: [PATCH 56/89] Update --- Tracking.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Tracking.yaml b/Tracking.yaml index 403f93c..f344e31 100644 --- a/Tracking.yaml +++ b/Tracking.yaml @@ -242,7 +242,7 @@ paths: deprecated: false "/track/v1/shipment/details/{inquiryNumber}": get: - summary: Track each Package in shipment + summary: Track Each Package in Shipment tags: - Tracking security: @@ -915,3 +915,4 @@ components: description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. ''KGS'' - kilograms.' + From 2afbcd968a031081488fb5951ee757a8718b0c40 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Mon, 2 Feb 2026 13:04:40 -0500 Subject: [PATCH 57/89] Update --- Tracking-Ready.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Tracking-Ready.yaml b/Tracking-Ready.yaml index 6c5216b..a3e051b 100644 --- a/Tracking-Ready.yaml +++ b/Tracking-Ready.yaml @@ -248,7 +248,7 @@ paths: deprecated: false "/track/v1/shipment/details/{inquiryNumber}": get: - summary: Track each Package in shipment + summary: Track Each Package in Shipment tags: - Tracking security: @@ -921,3 +921,4 @@ components: description: 'The weight units of measurement. Valid values: ''LBS'' - pounds. ''KGS'' - kilograms.' + From 63f5fc81a82abc57bfc044c9c4b1fea143bf3132 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 11:47:59 -0500 Subject: [PATCH 58/89] Update --- Forwarding.yaml | 195 ++++++++++++++++++++++++------------------------ 1 file changed, 98 insertions(+), 97 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index 35a0f8f..dec2418 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -12,10 +12,11 @@ info: - Built-in tracking and visibility tools improve shipment transparency. - Streamlined documentation and developer support reduce onboarding time - NOTE: Please contact for GUID support - + # Reference - Errors + + servers: - url: https://www.onlinetools.ups.com/api/forwarding/{version} @@ -107,8 +108,8 @@ paths: company: Third Party Logistics account: "123456789" address1: 7890 LOGISTICS RD - - + + city: ATLANTA state: GA postalCode: "30303" @@ -343,13 +344,13 @@ paths: contactName: Subaru contactPhone: "541813846" contactEmail: subaru@ups.com - - - - - - - + + + + + + + company: SUBARU OF AMERICA address1: 1410 N LOMBARD ST city: PORTLAND @@ -359,7 +360,7 @@ paths: consignee: account: serviceCenterCode: MAA - + contactName: Harry contactPhone: "8885888778" contactEmail: HarryTest@ups.com @@ -1071,19 +1072,19 @@ paths: description: The criteria used to search for Orders required: true schema: - + $ref: "#/components/schemas/ApolloOrderSearchRequestV1" - - - - - - - - - + + + + + + + + + responses: "200": description: OK @@ -1112,7 +1113,7 @@ paths: consignee: account: "123456789" serviceCenterCode: BOS - + contactName: Sheldon contactPhone: "8888888778" contactEmail: test2@ups.com @@ -1958,8 +1959,8 @@ paths: shipper: account: "123456789" address1: "123 Main St" - - + + city: "New York" state: "NY" postalCode: "10001" @@ -1979,8 +1980,8 @@ paths: consignee: account: "999999999" address1: "456 Market St" - - + + city: "San Francisco" state: "CA" postalCode: "94105" @@ -2001,8 +2002,8 @@ paths: company: Third Party Logistics account: "123456789" address1: 7890 LOGISTICS RD - - + + city: ATLANTA state: GA postalCode: "30303" @@ -2055,10 +2056,10 @@ paths: - key: serialNumber value: SN654321 details: - - - - + + + + - key: DV value: "1000" - key: DV-Currency @@ -2166,7 +2167,7 @@ paths: label: format: "PDF" layout: "AF-GEMINI" - + image: "Base64EncodedPDF" "400": description: Bad Request @@ -2256,10 +2257,10 @@ paths: summary: Get Shipment Details description: Retrieves shipment details for air or ocean quotes based on the specified request parameters. operationId: getShipmentDetails - + tags: - Forwarding - + parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -2268,7 +2269,7 @@ paths: - $ref: "#/components/parameters/X-ClientId" - name: request_type in: query - + required: true schema: type: string @@ -2276,26 +2277,26 @@ paths: enum: [Air, Ocean] example: Ocean description: The type of shipment ("Air" or "Ocean"). - - - - - + + + + + - name: shipment_id in: query - + required: true schema: type: string - - - - - - - - - + + + + + + + + + description: Unique identifier for the shipment. example: "200025511" description: The unique identifier for the shipment. @@ -5243,21 +5244,21 @@ components: - AMG - AM - D2G - - + + - D2 - DFG - - + + - DF - CX - - + + - CA - + - EC - - + + paymentType: type: string description: Payment type. @@ -5758,8 +5759,8 @@ components: required: - shipperAccountNumber - orderNumber - - + + properties: shipperAccountNumber: $ref: "#/components/schemas/ApolloShipperAccountNumberV1" @@ -6015,35 +6016,35 @@ components: type: integer format: int32 minimum: 1 - + example: 1 length: description: The length of each component in the item type: number format: float minimum: 1 - + example: 10 width: description: The width of each component in the item type: number format: float minimum: 1 - + example: 10 height: description: The height of each component in the item type: number format: float minimum: 1 - + example: 10 weight: description: The weight of each component in the item type: number format: float minimum: 1 - + example: 10 additionalProperties: false additionalProperties: false @@ -6748,7 +6749,7 @@ components: - integer - "null" format: int32 - + minimum: 1 maximum: 99999 example: 10 @@ -6756,7 +6757,7 @@ components: description: Length of this item type: number format: float - + minimum: 1 maximum: 999 example: 10 @@ -6764,7 +6765,7 @@ components: description: Width of this item type: number format: float - + minimum: 1 maximum: 999 example: 10 @@ -6772,7 +6773,7 @@ components: description: Height of this item type: number format: float - + minimum: 1 maximum: 999 example: 10 @@ -6780,7 +6781,7 @@ components: description: Total weight of these items type: number format: float - + minimum: 1 maximum: 99999 example: 10 @@ -6986,7 +6987,7 @@ components: description: The total number of items in the order type: integer format: int32 - + minimum: 1 example: 2 labelService: @@ -7025,9 +7026,9 @@ components: ApolloPartyV1: type: object description: Party information (shipper, consignee, or third party). - - - + + + properties: company: type: @@ -7340,7 +7341,7 @@ components: required: - op - path - + properties: op: type: @@ -7392,12 +7393,12 @@ components: type: string description: Indicates if charge is included in base rate (Y/N) example: "N" - - - - - - + + + + + + #/air/ship ApolloAirShipRequestV1: @@ -7409,9 +7410,9 @@ components: consignee: $ref: '#/components/schemas/PartyDetails' thirdParty: - - - + + + type: [object, "null"] description: ThirdParty details for the shipment. oneOf: @@ -7590,12 +7591,12 @@ components: pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ example: "john.doe@shipper.com" partySectionDetails: - - - + + + description: Additional details about the party as key-value pairs. $ref: "#/components/schemas/ApolloCustomArrayV1" - + details: description: Additional details about the party as key-value pairs. $ref: "#/components/schemas/ApolloCustomArrayV1" @@ -7824,8 +7825,8 @@ components: description: The hold at airport time. example: "2025-08-12T12:00:00Z" totalCharge: - - + + description: Total charge for the shipment. $ref: "#/components/schemas/ApolloChargeAmountV1" currency: @@ -7869,10 +7870,10 @@ components: type: string description: The layout of the label. example: "4x6" - - - - + + + + image: type: string format: byte From 487c9b016ed877602eb104df6409335d306c03f4 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 11:49:02 -0500 Subject: [PATCH 59/89] Update --- Transportation.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Transportation.yaml b/Transportation.yaml index da955a3..19c136d 100644 --- a/Transportation.yaml +++ b/Transportation.yaml @@ -3,7 +3,7 @@ info: title: "UPS Partner’s Transportation Data Ingestion API" description: | ## Purpose - This API is used to ingest the partner's(UPS SCS customers) shipments data into Symphony. This data is processed and made visible on Symphony for tracking. + The Transportation API is used to ingest UPS SCS customer shipments data into Symphony. This data is processed and made visible on Symphony for tracking. API to post transportation order data for point to point shipments to allow for a near real time visibility. API supports only standalone transactions and does not support data aggregations or orchestration with different source systems. version: "1.0" tags: From a00511baf2071303a055847b082e31cbf550d9d6 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 12:02:36 -0500 Subject: [PATCH 60/89] Update --- Forwarding.yaml | 99 +------------------------------------------------ 1 file changed, 1 insertion(+), 98 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index dec2418..37439ed 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -15,9 +15,7 @@ info: # Reference - Errors - - - + servers: - url: https://www.onlinetools.ups.com/api/forwarding/{version} description: URL for OAuth based authentication that can be used for the UPS Production environment. @@ -108,8 +106,6 @@ paths: company: Third Party Logistics account: "123456789" address1: 7890 LOGISTICS RD - - city: ATLANTA state: GA postalCode: "30303" @@ -344,13 +340,6 @@ paths: contactName: Subaru contactPhone: "541813846" contactEmail: subaru@ups.com - - - - - - - company: SUBARU OF AMERICA address1: 1410 N LOMBARD ST city: PORTLAND @@ -360,7 +349,6 @@ paths: consignee: account: serviceCenterCode: MAA - contactName: Harry contactPhone: "8885888778" contactEmail: HarryTest@ups.com @@ -1072,19 +1060,9 @@ paths: description: The criteria used to search for Orders required: true schema: - $ref: "#/components/schemas/ApolloOrderSearchRequestV1" - - - - - - - - - responses: "200": description: OK @@ -1113,7 +1091,6 @@ paths: consignee: account: "123456789" serviceCenterCode: BOS - contactName: Sheldon contactPhone: "8888888778" contactEmail: test2@ups.com @@ -1959,8 +1936,6 @@ paths: shipper: account: "123456789" address1: "123 Main St" - - city: "New York" state: "NY" postalCode: "10001" @@ -1980,8 +1955,6 @@ paths: consignee: account: "999999999" address1: "456 Market St" - - city: "San Francisco" state: "CA" postalCode: "94105" @@ -2002,8 +1975,6 @@ paths: company: Third Party Logistics account: "123456789" address1: 7890 LOGISTICS RD - - city: ATLANTA state: GA postalCode: "30303" @@ -2056,10 +2027,6 @@ paths: - key: serialNumber value: SN654321 details: - - - - - key: DV value: "1000" - key: DV-Currency @@ -2167,7 +2134,6 @@ paths: label: format: "PDF" layout: "AF-GEMINI" - image: "Base64EncodedPDF" "400": description: Bad Request @@ -2257,10 +2223,8 @@ paths: summary: Get Shipment Details description: Retrieves shipment details for air or ocean quotes based on the specified request parameters. operationId: getShipmentDetails - tags: - Forwarding - parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -2269,7 +2233,6 @@ paths: - $ref: "#/components/parameters/X-ClientId" - name: request_type in: query - required: true schema: type: string @@ -2277,26 +2240,11 @@ paths: enum: [Air, Ocean] example: Ocean description: The type of shipment ("Air" or "Ocean"). - - - - - - name: shipment_id in: query - required: true schema: type: string - - - - - - - - - description: Unique identifier for the shipment. example: "200025511" description: The unique identifier for the shipment. @@ -5244,21 +5192,12 @@ components: - AMG - AM - D2G - - - D2 - DFG - - - DF - CX - - - CA - - EC - - paymentType: type: string description: Payment type. @@ -5759,8 +5698,6 @@ components: required: - shipperAccountNumber - orderNumber - - properties: shipperAccountNumber: $ref: "#/components/schemas/ApolloShipperAccountNumberV1" @@ -6016,35 +5953,30 @@ components: type: integer format: int32 minimum: 1 - example: 1 length: description: The length of each component in the item type: number format: float minimum: 1 - example: 10 width: description: The width of each component in the item type: number format: float minimum: 1 - example: 10 height: description: The height of each component in the item type: number format: float minimum: 1 - example: 10 weight: description: The weight of each component in the item type: number format: float minimum: 1 - example: 10 additionalProperties: false additionalProperties: false @@ -6749,7 +6681,6 @@ components: - integer - "null" format: int32 - minimum: 1 maximum: 99999 example: 10 @@ -6757,7 +6688,6 @@ components: description: Length of this item type: number format: float - minimum: 1 maximum: 999 example: 10 @@ -6765,7 +6695,6 @@ components: description: Width of this item type: number format: float - minimum: 1 maximum: 999 example: 10 @@ -6773,7 +6702,6 @@ components: description: Height of this item type: number format: float - minimum: 1 maximum: 999 example: 10 @@ -6781,7 +6709,6 @@ components: description: Total weight of these items type: number format: float - minimum: 1 maximum: 99999 example: 10 @@ -6987,7 +6914,6 @@ components: description: The total number of items in the order type: integer format: int32 - minimum: 1 example: 2 labelService: @@ -7026,9 +6952,6 @@ components: ApolloPartyV1: type: object description: Party information (shipper, consignee, or third party). - - - properties: company: type: @@ -7341,7 +7264,6 @@ components: required: - op - path - properties: op: type: @@ -7393,12 +7315,6 @@ components: type: string description: Indicates if charge is included in base rate (Y/N) example: "N" - - - - - - #/air/ship ApolloAirShipRequestV1: @@ -7410,9 +7326,6 @@ components: consignee: $ref: '#/components/schemas/PartyDetails' thirdParty: - - - type: [object, "null"] description: ThirdParty details for the shipment. oneOf: @@ -7591,12 +7504,8 @@ components: pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ example: "john.doe@shipper.com" partySectionDetails: - - - description: Additional details about the party as key-value pairs. $ref: "#/components/schemas/ApolloCustomArrayV1" - details: description: Additional details about the party as key-value pairs. $ref: "#/components/schemas/ApolloCustomArrayV1" @@ -7825,8 +7734,6 @@ components: description: The hold at airport time. example: "2025-08-12T12:00:00Z" totalCharge: - - description: Total charge for the shipment. $ref: "#/components/schemas/ApolloChargeAmountV1" currency: @@ -7870,10 +7777,6 @@ components: type: string description: The layout of the label. example: "4x6" - - - - image: type: string format: byte From 6b73c97284f72a45d3808a9e2498975892e7c70b Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 12:50:56 -0500 Subject: [PATCH 61/89] Update --- Forwarding.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/Forwarding.yaml b/Forwarding.yaml index 37439ed..c416df5 100644 --- a/Forwarding.yaml +++ b/Forwarding.yaml @@ -12,10 +12,8 @@ info: - Built-in tracking and visibility tools improve shipment transparency. - Streamlined documentation and developer support reduce onboarding time - # Reference - Errors - servers: - url: https://www.onlinetools.ups.com/api/forwarding/{version} description: URL for OAuth based authentication that can be used for the UPS Production environment. From 70cd6eea2c298b7b943a80ef55b00569aabfbcc8 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 13:27:18 -0500 Subject: [PATCH 62/89] Delete Transportation.yaml --- Transportation.yaml | 1306 ------------------------------------------- 1 file changed, 1306 deletions(-) delete mode 100644 Transportation.yaml diff --git a/Transportation.yaml b/Transportation.yaml deleted file mode 100644 index 19c136d..0000000 --- a/Transportation.yaml +++ /dev/null @@ -1,1306 +0,0 @@ -openapi: 3.1.0 -info: - title: "UPS Partner’s Transportation Data Ingestion API" - description: | - ## Purpose - The Transportation API is used to ingest UPS SCS customer shipments data into Symphony. This data is processed and made visible on Symphony for tracking. - API to post transportation order data for point to point shipments to allow for a near real time visibility. API supports only standalone transactions and does not support data aggregations or orchestration with different source systems. - version: "1.0" -tags: - - name: "Transportation" - description: "Partner Publisher API" -servers: - - url: https:onlinetools.ups.com/api/transaction-visibility-dashboard/v1 - description: This is the Symphony server URL for partner publisher api. - -paths: - "/Ingest": - post: - summary: Ingest partner's shipments data in bulk - description: "This API is used to ingest the partner's shipments data into Symphony." - operationId: SC360_PublisherAPI_Ingest - tags: - - Transportation - security: - - OAuth2ClientCredentialsWithAssertion: [] - x-slo: - availability: "99%" - response_time: - - percentile: 99 - value: "900 ms" - - percentile: 95 - value: "750 ms" - requestBody: - content: - application/json: - schema: - "$ref": "#/components/schemas/SC360InterfaceSC360IngestRequest" - examples: - sampleTransportationOrderRequest: - value: - request: - docFlow: 'Inbound' - docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: Order - docVer: 1.0.0.0 - orderDetails: - - customerAccountNumber: DEMO - orderNumber: LD123437 - customerPONumber: PO44859478 - orderPlacedDate: '2023-07-09T11:07:38.446' - shipmentDetails: - - activityInformation: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - activityID: Delivered - activityLocation: - city: Houston - country: US - latitude: "+29.749907" - longitude: "-95.358421" - postalCode: '75847' - stateProvince: TX - deliveryInformation: - actualDeliveryDateTime: '2023-08-03 10:13:00.000' - actualDeliveryDateTimegmtOffset: "-04:00" - podSignedBy: John - podSignedOn: '2023-08-03 10:13:00.000' - description: delivered - localDateTime: '2019-08-24T14:15:22Z' - sensorEvent: true - type: activity - actualPickupDateTime: '2019-08-24T14:15:22Z' - billingInformation: - billingTermCode: consignee - billingTermDescription: to be paid by consignee - carrier: - carrierCode: convergence - carrierName: Sample - earliestDeliveryDateTime: '2019-08-24T14:15:22Z' - internationalShipment: - harmonizedCommodityCode: - shipmentExportCountryCode: - specialInstructions: - latestDeliveryDateTime: '2019-08-24T14:15:22Z' - leadShipmentNumber: SN4765746545 - partyDetails: - - city: CLEVELAND - countryCode: US - stateCode: 'GA' - type: Shipper - - city: Atlanta - countryCode: US - stateCode: 'GA' - type: Consignee - rescheduledDeliveryDateTime: '2019-08-24T14:15:22Z' - scheduledDeliveryDateTime: '2019-08-24T14:15:22Z' - scheduledPickupDateTime: '2019-08-24T14:15:22Z' - sensorData: - gps: - city: Houston - country: US - latitude: "+29.749907" - longitude: "-95.358421" - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - localDateTime: - humidityLevel: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - humidity: '40' - humidityUOM: g/m3 - localDateTime: - lightStrength: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - light: '100' - lightUOM: lux - localDateTime: - shockForce: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - localDateTime: - shock: '10' - shockUOM: g - temperature: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - localDateTime: - temperatureInfo: '10' - temperatureUOM: C - service: - carrierServiceCode: Standard - carrierServiceDescription: Standard - handlingCode: - handlingDescription: - saturdayDeliveryFlag: Y - serviceCode: Ground - serviceDescription: Ground - shipUnits: - - dimensionWeight: '100' - dimensionWeightUOM: kg - height: '2.0' - heightUOM: m - itemDesciption: medical equipment - length: '5.0' - lengthUOM: m - weight: '50' - weightUOM: kg - width: '5.0' - widthUOM: m - shipmentQuantity: 100 - volume: '50.0' - volumeUOM: dm3 - shipmentDescription: Vaccination - shipmentNumber: SN1658566 - shipmentReferences: - - referenceType: Order - referenceValue: SO67890 - specialInformation: - hazmatCategoryCode: Explosives - hazmatCategoryDescription: Explosives - hazmatFlag: 'Y' - temperatureCondition: cold - shipmentPlacedDate: '2019-08-24T14:15:22Z' - carrierShipmentNumber: - - 1Z7Y47110445061158 - - 1Z0445067Y47111148 - shipmentUniqueKey: DEMO_SN1658566_20230709 - shipmentBookedDate: '2019-08-24T14:15:22Z' - exceptionInformation: - exceptionType: Damaged - reasonCode: Damaged due to weather - reasonDescription: Damaged due to weather - resolutionCode: Damaged - resolutionDescription: - statusCode: - statusDescription: Damaged delivery - exceptionCreatedDate: '2019-08-24T14:15:22Z' - exceptionCreatedDateGmt: '2019-08-24T14:15:22Z' - exceptionCreatedDateGmtOffset: "-04:00" - originalDocId: 2767bc53-060c-46d7-bc66-739a09216b35 - sourceSystem: PartnerA - apiVersion: v1.0 - - - responses: - '200': - description: Success - content: - application/json: - schema: - "$ref": "#/components/schemas/SC360ResponseListServiceResponse" - examples: - sampleTransportationOrderSuccessResponse: - value: - errors: - - code: - message: - source: - isCompleted: true - isFaulted: false - result: - - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 - orderNumber: LD123437 - shipmentNumber: SN1658566 - shipmentUniquekey: DEMO_SN1658566_20230709 - docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: Order - isCompleted: true - '207': - description: Multi-Status Success Response - content: - application/json: - schema: - "$ref": "#/components/schemas/SC360ResponseListServiceResponse" - examples: - sampleTransportationOrderSuccessResponse: - value: - errors: - - code: - message: - source: - isCompleted: true - isFaulted: false - result: - - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 - orderNumber: LD123437 - shipmentNumber: SN1658566 - shipmentUniquekey: DEMO_SN1658566_20230709 - docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: Order - isCompleted: true - - messageId: a9ea93db-1e51-492f-83c4-d864c95db056 - orderNumber: LD123438 - shipmentNumber: SN1658567 - shipmentUniquekey: DEMO_SN1658566_20230710 - docId: 62551ca8-36c8-4655-84f1-1459440ee9ee - docType: Order - isCompleted: false - '400': - description: Bad Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ObjectServiceResponse" - examples: - sampleTransportationOrderErrorResponse: - value: - errors: - - code: '400' - message: One or more required property is not provided value - source: shipmentUniqueKey - isCompleted: true - isFaulted: true - result: - '401': - description: Authorization Error - content: - application/json: - schema: - "$ref": "#/components/schemas/ObjectServiceResponse" - examples: - sampleTransportationOrderErrorResponse: - value: - errors: - - code: '401' - message: Unauthorized - source: - isCompleted: true - isFaulted: true - result: - '500': - description: Server Error - content: - application/json: - schema: - "$ref": "#/components/schemas/ObjectServiceResponse" - examples: - sampleTransportationOrderErrorResponse: - value: - errors: - - code: '500' - message: Unexpected server error has occurred. Please try again after some time. - source: - isCompleted: true - isFaulted: true - result: -components: - schemas: - ActivityInformation: - type: object - description: Use this to provide info about activities and milestones updates for the shipment. - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2023-07-09T11:07:38.446' - gmtOffset: - minLength: 1 - maxLength: 20 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - activityID: - description: Unique identifier for the activity - minLength: 1 - maxLength: 128 - type: [string, "null"] - example: Delivered - activityLocation: - description: Location details of the activity - "$ref": "#/components/schemas/ActivityLocation" - activitySubType: - description: Optional field used to specify additional details for the activity - minLength: 1 - maxLength: 250 - type: [string, "null"] - example: OnTime - activitySubTypeDescription: - description: Field used to specify additional details for the activity sub type - minLength: 1 - maxLength: 250 - type: [string, "null"] - deliveryInformation: - description: This field is used to capture any details about package delivery - "$ref": "#/components/schemas/DeliveryInformation" - description: - minLength: 1 - maxLength: 250 - type: string - description: activity description - example: Package delivered to consignee - localDateTime: - minLength: 1 - maxLength: 100 - type: string - format: date-time - sensorEvent: - description: Use this flag to specify if this activity is a result of sensor event - type: [boolean, "null"] - type: - description: This field is used to specify the type of activity or event - minLength: 1 - maxLength: 25 - type: string - additionalProperties: true - ActivityLocation: - type: object - properties: - city: - description: City name where the activity generated - minLength: 1 - maxLength: 512 - type: string - example: Atlanta - country: - description: Country name where the activity generated - minLength: 1 - maxLength: 512 - type: string - example: United States Of America - latitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Latitude - example: "+29.749907" - longitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Longitude - example: "-95.358421" - postalCode: - minLength: 1 - maxLength: 25 - type: [string, "null"] - stateProvince: - minLength: 1 - maxLength: 512 - type: [string, "null"] - example: "GA" - additionalProperties: false - BillingInformation: - type: object - description: Use this field to specify whom the shipment is charged to and descriptions for billing code - properties: - billingTermCode: - description: Use this field to specify whom the shipment is charged to (consignee, shipper, third party) - minLength: 1 - maxLength: 10 - type: [string, "null"] - example: ThirdParty - billingTermDescription: - description: Descriptions for billing code - minLength: 1 - maxLength: 1000 - type: [string, "null"] - example: Paid by third party - additionalProperties: false - Carrier: - type: object - description: Use this field to provide info about carrier used for shipment - properties: - carrierCode: - description: Carrier code of carrier used for shipment - minLength: 1 - maxLength: 50 - type: [string, "null"] - example: UGFF - carrierName: - minLength: 1 - maxLength: 255 - type: [string, "null"] - carrierType: - description: Carrier type of carrier used for shipment - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Freight - additionalProperties: false - DeliveryInformation: - type: object - description: This field is used to capture any details about package delivery - properties: - actualDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2023-07-09T11:07:38.446' - actualDeliveryDateTimegmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: actual delivery datetime gmt offset - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - podSignatureImage: - minLength: 1 - type: [string, "null"] - format: base64encodedstring - podSignatureText: - minLength: 1 - type: [string, "null"] - podSignedBy: - minLength: 1 - maxLength: 500 - type: [string, "null"] - example: "John" - podSignedOn: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - additionalProperties: false - Error: - type: object - properties: - code: - minLength: 1 - maxLength: 500 - type: [string, "null"] - message: - minLength: 1 - maxLength: 500 - type: [string, "null"] - source: - description: Source method name from where the exception is generated - minLength: 1 - maxLength: 500 - type: [string, "null"] - additionalProperties: false - ExceptionInformation: - type: object - description: This is used to provide additional details about the package delivery exception - properties: - exceptionType: - description: This field is used to provide type of exception - minLength: 1 - maxLength: 255 - type: string - example: Damaged - reasonCode: - description: This field is used to provide reason code of exception - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Weather - reasonDescription: - description: This field is used to provide reason description of exception - minLength: 1 - maxLength: 2000 - type: [string, "null"] - example: Hot weather - resolutionCode: - description: This field is used to provide resolution code of exception - minLength: 1 - maxLength: 255 - type: string - example: Freezer - resolutionDescription: - description: This field is used to provide resolution description of exception - minLength: 1 - maxLength: 2000 - type: [string, "null"] - example: Freezer will be used for vaccines - statusCode: - description: This field is used to provide status code of exception - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Controllable - statusDescription: - description: This field is used to provide status description of exception - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Controllable - exceptionCreatedDate: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - exceptionCreatedDateGmt: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - exceptionCreatedDateGmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - additionalProperties: false - Gps: - type: object - description: Use this field for shipment tracking - properties: - city: - description: City name where the shipment is currently present - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: Atlanta - country: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Country name where the shipment is currently present - example: United States Of America - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - latitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Latitude - example: "+29.749907" - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - longitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Longitude - example: "-95.358421" - additionalProperties: false - HumidityLevel: - type: object - description: Use this field to provide information about the shipment humidity conditions - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - humidity: - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "40" - humidityUOM: - description: Humidity Unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: g/m3 - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - additionalProperties: false - InternationalShipment: - description: Use this field for international shipment info like country and commodity code - type: object - properties: - harmonizedCommodityCode: - description: The international commodity or harmonized code that represents the commodity contained in the invoice line - minLength: 1 - maxLength: 50 - type: [string, "null"] - example: "0701.10" - shipmentExportCountryCode: - description: Country Code of shipment export - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: US - specialInstructions: - description: Any international special instructions required - minLength: 1 - type: [string, "null"] - additionalProperties: false - LightStrength: - description: Light sensor data - type: object - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - light: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Light sensor - example: "20" - lightUOM: - minLength: 1 - maxLength: 25 - type: [string, "null"] - enum: - - lux - - candles - - lumens - - footcandles - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - additionalProperties: false - ObjectServiceResponse: - description: Service response object containgin details if the shipments were processed successfully or not. - type: object - properties: - errors: - type: [array, "null"] - items: - "$ref": "#/components/schemas/Error" - isCompleted: - description: This field denotes if the request was processed successfully or not - type: boolean - isFaulted: - description: This field denotes if there is any error while precessing the shipments - type: boolean - result: - description: List of shipments received in request with the status if they were processed successfully or not - type: [object, "null"] - additionalProperties: false - OrderDetails: - required: - - customerAccountNumber - - shipmentDetails - type: object - description: Use this section to provide/map info about the order (ex load, shipment etc) - properties: - customerAccountNumber: - minLength: 1 - maxLength: 100 - type: string - pattern: ^[a-zA-Z0-9_]*$ - orderNumber: - minLength: 1 - maxLength: 100 - type: [string, "null"] - customerPONumber: - minLength: 1 - type: [string, "null"] - description: Customer Purchase Order Number - example: "SO1023674" - orderPlacedDate: - minLength: 1 - maxLength: 100 - type: string - format: date-time - example: '2023-07-09T11:07:38.446' - shipmentDetails: - type: array - description: Use this section to provide information about the shipment - maxItems: 500 - items: - "$ref": "#/components/schemas/ShipmentDetail" - additionalProperties: false - PartyDetail: - description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc. - type: object - properties: - city: - minLength: 1 - maxLength: 512 - type: string - description: Party(Shipper, Consignee, etc) city name - example: Atlanta - countryCode: - minLength: 1 - maxLength: 50 - type: string - description: Party(Shipper, Consignee, etc) Country code - example: US - stateCode: - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "GA" - type: - minLength: 1 - maxLength: 10 - type: string - enum: - - Shipper - - Consignee - additionalProperties: false - SC360Interface: - description: Supply chain 360 interface - required: - - docType - - orderDetails - - sourceSystem - type: object - properties: - sbMessageId: - description: Service Bus message id - minLength: 1 - type: [string, "null"] - example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" - docFlow: - minLength: 1 - maxLength: 25 - type: string - description: Field for publishers to populate about the document flow type - enum: - - Inbound - - Outbound - docId: - minLength: 16 - maxLength: 50 - type: string - description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. - docTime: - minLength: 1 - maxLength: 100 - type: string - description: Current Date/Time when message is generated in UTC format - format: date-time - docType: - minLength: 1 - maxLength: 25 - type: string - enum: - - OrderStatus - - Order - docVer: - minLength: 1 - maxLength: 10 - type: string - description: Document version. Current version is 1.0 - transactionType: - minLength: 1 - type: [string, "null"] - orderDetails: - type: array - maxItems: 500 - items: - "$ref": "#/components/schemas/OrderDetails" - originalDocId: - minLength: 1 - maxLength: 50 - type: [string, "null"] - description: Unique Identifier for JSON message at the publisher side. Optional field for message publishers to populate - sourceSystem: - minLength: 1 - maxLength: 50 - type: string - description: source system name - example: "BOMI" - partnerId: - minLength: 1 - type: [string, "null"] - additionalProperties: false - SC360InterfaceSC360IngestRequest: - description: Supply chain 360 interface ingest request - required: - - apiVersion - - request - type: object - properties: - request: - "$ref": "#/components/schemas/SC360Interface" - apiVersion: - minLength: 1 - type: string - enum: - - v1.0 - additionalProperties: false - SC360Response: - description: Supply chain 360 response - required: - - docId - - docType - - messageId - - orderNumber - - shipmentNumber - - shipmentUniquekey - type: object - properties: - messageId: - description: Service bus message id for a shipment - minLength: 1 - type: string - example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" - orderNumber: - description: Unique identifier for the order/load. An order could have multiple shipments. - minLength: 1 - type: string - example: LD123437 - shipmentNumber: - minLength: 1 - type: string - description: Unique identifier of a shipment - example: SN12345678 - shipmentUniquekey: - minLength: 1 - type: string - description: shipmentUniqueKey is used to uniquely identify a shipment - example: BOMI_SN1658566_20230709 - docId: - minLength: 1 - type: string - description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. - example: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: - minLength: 1 - type: string - enum: - - OrderStatus - - Order - isCompleted: - type: boolean - additionalProperties: false - SC360ResponseListServiceResponse: - description: Supply chain 360 response list of process shipments - type: object - properties: - errors: - type: [array, "null"] - items: - "$ref": "#/components/schemas/Error" - isCompleted: - description: This field denotes if the request was processed successfully or not - type: boolean - isFaulted: - description: This field denotes if there is any error while precessing the shipments - type: boolean - result: - description: List of shipments received in request with the status if they were processed successfully or not - type: [array, "null"] - items: - "$ref": "#/components/schemas/SC360Response" - additionalProperties: false - SensorData: - type: object - description: This section is used for capturing sensor level data for the package when the sensor event flag is true - properties: - gps: - "$ref": "#/components/schemas/Gps" - humidityLevel: - "$ref": "#/components/schemas/HumidityLevel" - lightStrength: - "$ref": "#/components/schemas/LightStrength" - shockForce: - "$ref": "#/components/schemas/ShockForce" - temperature: - "$ref": "#/components/schemas/Temperature" - additionalProperties: false - Service: - type: object - description: Service information like service code (ex ground, overnight, international and descriptions) - properties: - carrierServiceCode: - description: Use this field to specify the carrier service level if different than service level - minLength: 1 - maxLength: 255 - type: string - example: Standard - carrierServiceDescription: - description: Description for carrier service level - minLength: 1 - type: [string, "null"] - example: Standard - handlingCode: - description: Shipment package handling instructions code - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Fragile - handlingDescription: - description: Shipment package handling instructions description - minLength: 1 - type: [string, "null"] - example: Fragile content, handle with care - saturdayDeliveryFlag: - minLength: 1 - maxLength: 1 - type: [string, "null"] - enum: - - Y - - N - serviceCode: - description: Code of service level for the shipment - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: GND - serviceDescription: - description: Description for the level of service - minLength: 1 - type: [string, "null"] - example: Ground - additionalProperties: false - ShipUnit: - description: List of shipping units like items, length, width, height, etc - type: object - properties: - dimensionWeight: - description: Shipment Unit Dimensional Weight. This is the estimated weight of the package based on its dimensions. - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "200.00" - dimensionWeightUOM: - description: Dimensional weight unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: kg/dm3 - height: - description: Height of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "25.10" - heightUOM: - description: Height unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: cm - itemDesciption: - description: Shipment unit items description - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: medical equipments - length: - description: Length of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "25.10" - lengthUOM: - description: Length unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: cm - weight: - description: Weight of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "20" - weightUOM: - description: Weight unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: kg - width: - description: Widht of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "25.10" - widthUOM: - description: Width unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: cm - shipmentQuantity: - description: Quantity of items in shipment unit - type: [integer, "null"] - format: int32 - example: 20 - volume: - description: Volume of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "50.0" - volumeUOM: - description: Volume unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: dm3 - additionalProperties: false - ShipmentDetail: - required: - - shipmentNumber - - shipmentPlacedDate - - shipmentUniqueKey - type: object - properties: - activityInformation: - description: Use this to provide info about activities and milestones updates for the shipment. - "$ref": "#/components/schemas/ActivityInformation" - actualPickupDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - billingInformation: - description: Use this field to specify whom the shipment is charged to and descriptions for billing code - "$ref": "#/components/schemas/BillingInformation" - carrier: - description: Use this field to provide info about carrier used for shipment - "$ref": "#/components/schemas/Carrier" - collectOnDeliveryAmount: - minLength: 1 - maxLength: 225 - type: [string, "null"] - collectOnDeliveryCurrency: - minLength: 1 - maxLength: 200 - type: [string, "null"] - description: Currency code of the amount received on delivery - earliestDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - internationalShipment: - "$ref": "#/components/schemas/InternationalShipment" - latestDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - leadShipmentNumber: - minLength: 1 - maxLength: 100 - type: [string, "null"] - description: Use this field to provide key information for the lead shipment in case there are multiple packages in a shipment - partyDetails: - type: [array, "null"] - description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc - items: - "$ref": "#/components/schemas/PartyDetail" - rescheduledDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - scheduledDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - scheduledPickupDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - sensorData: - description: This section is used for capturing sensor level data for the package - "$ref": "#/components/schemas/SensorData" - service: - "$ref": "#/components/schemas/Service" - shipUnits: - type: [array, "null"] - description: List of shipping units like number of items, length, width, height, - items: - "$ref": "#/components/schemas/ShipUnit" - shipmentDescription: - minLength: 1 - maxLength: 1000 - type: [string, "null"] - description: Shipment contents description text - example: fragile material - shipmentNumber: - minLength: 1 - maxLength: 100 - type: string - description: Unique identifier of a shipment - example: SN12345678 - shipmentReferences: - type: [array, "null"] - description: List of reference information about the package - items: - "$ref": "#/components/schemas/ShipmentReference" - specialInformation: - description: Provide any special information about shipment like Hazardous material - "$ref": "#/components/schemas/SpecialInformation" - temperatureCondition: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Temperature condition - example: "Amber" - shipmentPlacedDate: - type: string - format: date-time - carrierShipmentNumber: - type: [array, "null"] - items: - type: string - shipmentUniqueKey: - minLength: 1 - maxLength: 100 - type: string - description: shipmentUniqueKey is used to uniquely identify a shipment - shipmentBookedDate: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - exceptionInformation: - description: This is used to provide additional details about the package delivery exception - "$ref": "#/components/schemas/ExceptionInformation" - additionalProperties: false - ShipmentReference: - type: object - description: List of reference information about the package - properties: - referenceCode: - minLength: 1 - maxLength: 50 - type: [string, "null"] - description: Code that identifies the reference value - example: Order - referenceType: - minLength: 1 - maxLength: 50 - type: string - description: This field is used to specify the type of reference field - example: shipment - referenceValue: - minLength: 1 - maxLength: 255 - type: string - description: Reference value - example: PO12345 - additionalProperties: false - ShockForce: - type: object - description: Has shipment been dropped or otherwise exposed to an impact force that exceeds a predetermined level - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - shock: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Shipment has been dropped or otherwise exposed to an impact force that exceeds a predetermined level - example: "20" - shockUOM: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Shock Unit of measurement - example: "g's" - additionalProperties: false - SpecialInformation: - type: object - description: Provide any special information about shipment like Hazardous material - properties: - hazmatCategoryCode: - minLength: 1 - maxLength: 255 - type: [string, "null"] - description: Hazardous material category code - example: Explosives - hazmatCategoryDescription: - minLength: 1 - maxLength: 1000 - type: [string, "null"] - description: Hazardous material category description - example: Explosives - hazmatFlag: - minLength: 1 - maxLength: 1 - type: [string, "null"] - enum: - - Y - - N - additionalProperties: false - Temperature: - type: object - description: Temperature information of the shipment - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - temperatureInfo: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Temperature value of the container - example: "10" - temperatureUOM: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Temperature unit of measurement - example: "C" - enum: - - C - - F - additionalProperties: false - securitySchemes: - OAuth2ClientCredentialsWithAssertion: - type: oauth2 - description: | - This API uses OAuth 2.0 with mutual TLS for client authentication. - The client must include a client assertion signed with a certificate in the token request to token endpoint - client_assertion_type: urn:ietf:params:oauth:client-assertion-type:jwt-bearer - flows: - clientCredentials: - tokenUrl: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token - scopes: {} -security: -- OAuth2ClientCredentialsWithAssertion: [] - From e807594615bfee1d843cae6e3ff03255ce749bc9 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 13:27:50 -0500 Subject: [PATCH 63/89] Add files via upload --- UPSSCSTransportationAPI.yaml | 1306 ++++++++++++++++++++++++++++++++++ 1 file changed, 1306 insertions(+) create mode 100644 UPSSCSTransportationAPI.yaml diff --git a/UPSSCSTransportationAPI.yaml b/UPSSCSTransportationAPI.yaml new file mode 100644 index 0000000..c8ac754 --- /dev/null +++ b/UPSSCSTransportationAPI.yaml @@ -0,0 +1,1306 @@ +openapi: 3.1.0 +info: + title: "UPS Partner’s Transportation Data Ingestion API" + description: | + ## Purpose + The Transportation API is used to ingest UPS SCS customer shipments data into Symphony. This data is processed and made visible on Symphony for tracking. + API to post transportation order data for point to point shipments to allow for a near real time visibility. API supports only standalone transactions and does not support data aggregations or orchestration with different source systems. + version: "1.0" +tags: + - name: "Transportation" + description: "Partner Publisher API" +servers: + - url: https:onlinetools.ups.com/api/transaction-visibility-dashboard/v1 + description: This is the Symphony server URL for partner publisher api. + +paths: + "/Ingest": + post: + summary: Ingest partner's shipments data in bulk + description: "This API is used to ingest the partner's shipments data into Symphony." + operationId: SC360_PublisherAPI_Ingest + tags: + - Transportation + security: + - OAuth2ClientCredentialsWithAssertion: [] + x-slo: + availability: "99%" + response_time: + - percentile: 99 + value: "900 ms" + - percentile: 95 + value: "750 ms" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360InterfaceSC360IngestRequest" + examples: + sampleTransportationOrderRequest: + value: + request: + docFlow: 'Inbound' + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + docVer: 1.0.0.0 + orderDetails: + - customerAccountNumber: DEMO + orderNumber: LD123437 + customerPONumber: PO44859478 + orderPlacedDate: '2023-07-09T11:07:38.446' + shipmentDetails: + - activityInformation: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + activityID: Delivered + activityLocation: + city: Houston + country: US + latitude: "+29.749907" + longitude: "-95.358421" + postalCode: '75847' + stateProvince: TX + deliveryInformation: + actualDeliveryDateTime: '2023-08-03 10:13:00.000' + actualDeliveryDateTimegmtOffset: "-04:00" + podSignedBy: John + podSignedOn: '2023-08-03 10:13:00.000' + description: delivered + localDateTime: '2019-08-24T14:15:22Z' + sensorEvent: true + type: activity + actualPickupDateTime: '2019-08-24T14:15:22Z' + billingInformation: + billingTermCode: consignee + billingTermDescription: to be paid by consignee + carrier: + carrierCode: convergence + carrierName: Sample + earliestDeliveryDateTime: '2019-08-24T14:15:22Z' + internationalShipment: + harmonizedCommodityCode: + shipmentExportCountryCode: + specialInstructions: + latestDeliveryDateTime: '2019-08-24T14:15:22Z' + leadShipmentNumber: SN4765746545 + partyDetails: + - city: CLEVELAND + countryCode: US + stateCode: 'GA' + type: Shipper + - city: Atlanta + countryCode: US + stateCode: 'GA' + type: Consignee + rescheduledDeliveryDateTime: '2019-08-24T14:15:22Z' + scheduledDeliveryDateTime: '2019-08-24T14:15:22Z' + scheduledPickupDateTime: '2019-08-24T14:15:22Z' + sensorData: + gps: + city: Houston + country: US + latitude: "+29.749907" + longitude: "-95.358421" + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + humidityLevel: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + humidity: '40' + humidityUOM: g/m3 + localDateTime: + lightStrength: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + light: '100' + lightUOM: lux + localDateTime: + shockForce: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + shock: '10' + shockUOM: g + temperature: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + temperatureInfo: '10' + temperatureUOM: C + service: + carrierServiceCode: Standard + carrierServiceDescription: Standard + handlingCode: + handlingDescription: + saturdayDeliveryFlag: Y + serviceCode: Ground + serviceDescription: Ground + shipUnits: + - dimensionWeight: '100' + dimensionWeightUOM: kg + height: '2.0' + heightUOM: m + itemDesciption: medical equipment + length: '5.0' + lengthUOM: m + weight: '50' + weightUOM: kg + width: '5.0' + widthUOM: m + shipmentQuantity: 100 + volume: '50.0' + volumeUOM: dm3 + shipmentDescription: Vaccination + shipmentNumber: SN1658566 + shipmentReferences: + - referenceType: Order + referenceValue: SO67890 + specialInformation: + hazmatCategoryCode: Explosives + hazmatCategoryDescription: Explosives + hazmatFlag: 'Y' + temperatureCondition: cold + shipmentPlacedDate: '2019-08-24T14:15:22Z' + carrierShipmentNumber: + - 1Z7Y47110445061158 + - 1Z0445067Y47111148 + shipmentUniqueKey: DEMO_SN1658566_20230709 + shipmentBookedDate: '2019-08-24T14:15:22Z' + exceptionInformation: + exceptionType: Damaged + reasonCode: Damaged due to weather + reasonDescription: Damaged due to weather + resolutionCode: Damaged + resolutionDescription: + statusCode: + statusDescription: Damaged delivery + exceptionCreatedDate: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmt: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmtOffset: "-04:00" + originalDocId: 2767bc53-060c-46d7-bc66-739a09216b35 + sourceSystem: PartnerA + apiVersion: v1.0 + + + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360ResponseListServiceResponse" + examples: + sampleTransportationOrderSuccessResponse: + value: + errors: + - code: + message: + source: + isCompleted: true + isFaulted: false + result: + - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 + orderNumber: LD123437 + shipmentNumber: SN1658566 + shipmentUniquekey: DEMO_SN1658566_20230709 + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + isCompleted: true + '207': + description: Multi-Status Success Response + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360ResponseListServiceResponse" + examples: + sampleTransportationOrderSuccessResponse: + value: + errors: + - code: + message: + source: + isCompleted: true + isFaulted: false + result: + - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 + orderNumber: LD123437 + shipmentNumber: SN1658566 + shipmentUniquekey: DEMO_SN1658566_20230709 + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + isCompleted: true + - messageId: a9ea93db-1e51-492f-83c4-d864c95db056 + orderNumber: LD123438 + shipmentNumber: SN1658567 + shipmentUniquekey: DEMO_SN1658566_20230710 + docId: 62551ca8-36c8-4655-84f1-1459440ee9ee + docType: Order + isCompleted: false + '400': + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '400' + message: One or more required property is not provided value + source: shipmentUniqueKey + isCompleted: true + isFaulted: true + result: + '401': + description: Authorization Error + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '401' + message: Unauthorized + source: + isCompleted: true + isFaulted: true + result: + '500': + description: Server Error + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '500' + message: Unexpected server error has occurred. Please try again after some time. + source: + isCompleted: true + isFaulted: true + result: +components: + schemas: + ActivityInformation: + type: object + description: Use this to provide info about activities and milestones updates for the shipment. + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2023-07-09T11:07:38.446' + gmtOffset: + minLength: 1 + maxLength: 20 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + activityID: + description: Unique identifier for the activity + minLength: 1 + maxLength: 128 + type: [string, "null"] + example: Delivered + activityLocation: + description: Location details of the activity + "$ref": "#/components/schemas/ActivityLocation" + activitySubType: + description: Optional field used to specify additional details for the activity + minLength: 1 + maxLength: 250 + type: [string, "null"] + example: OnTime + activitySubTypeDescription: + description: Field used to specify additional details for the activity sub type + minLength: 1 + maxLength: 250 + type: [string, "null"] + deliveryInformation: + description: This field is used to capture any details about package delivery + "$ref": "#/components/schemas/DeliveryInformation" + description: + minLength: 1 + maxLength: 250 + type: string + description: activity description + example: Package delivered to consignee + localDateTime: + minLength: 1 + maxLength: 100 + type: string + format: date-time + sensorEvent: + description: Use this flag to specify if this activity is a result of sensor event + type: [boolean, "null"] + type: + description: This field is used to specify the type of activity or event + minLength: 1 + maxLength: 25 + type: string + additionalProperties: true + ActivityLocation: + type: object + properties: + city: + description: City name where the activity generated + minLength: 1 + maxLength: 512 + type: string + example: Atlanta + country: + description: Country name where the activity generated + minLength: 1 + maxLength: 512 + type: string + example: United States Of America + latitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Latitude + example: "+29.749907" + longitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Longitude + example: "-95.358421" + postalCode: + minLength: 1 + maxLength: 25 + type: [string, "null"] + stateProvince: + minLength: 1 + maxLength: 512 + type: [string, "null"] + example: "GA" + additionalProperties: false + BillingInformation: + type: object + description: Use this field to specify whom the shipment is charged to and descriptions for billing code + properties: + billingTermCode: + description: Use this field to specify whom the shipment is charged to (consignee, shipper, third party) + minLength: 1 + maxLength: 10 + type: [string, "null"] + example: ThirdParty + billingTermDescription: + description: Descriptions for billing code + minLength: 1 + maxLength: 1000 + type: [string, "null"] + example: Paid by third party + additionalProperties: false + Carrier: + type: object + description: Use this field to provide info about carrier used for shipment + properties: + carrierCode: + description: Carrier code of carrier used for shipment + minLength: 1 + maxLength: 50 + type: [string, "null"] + example: UGFF + carrierName: + minLength: 1 + maxLength: 255 + type: [string, "null"] + carrierType: + description: Carrier type of carrier used for shipment + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Freight + additionalProperties: false + DeliveryInformation: + type: object + description: This field is used to capture any details about package delivery + properties: + actualDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2023-07-09T11:07:38.446' + actualDeliveryDateTimegmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: actual delivery datetime gmt offset + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + podSignatureImage: + minLength: 1 + type: [string, "null"] + format: base64encodedstring + podSignatureText: + minLength: 1 + type: [string, "null"] + podSignedBy: + minLength: 1 + maxLength: 500 + type: [string, "null"] + example: "John" + podSignedOn: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + Error: + type: object + properties: + code: + minLength: 1 + maxLength: 500 + type: [string, "null"] + message: + minLength: 1 + maxLength: 500 + type: [string, "null"] + source: + description: Source method name from where the exception is generated + minLength: 1 + maxLength: 500 + type: [string, "null"] + additionalProperties: false + ExceptionInformation: + type: object + description: This is used to provide additional details about the package delivery exception + properties: + exceptionType: + description: This field is used to provide type of exception + minLength: 1 + maxLength: 255 + type: string + example: Damaged + reasonCode: + description: This field is used to provide reason code of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Weather + reasonDescription: + description: This field is used to provide reason description of exception + minLength: 1 + maxLength: 2000 + type: [string, "null"] + example: Hot weather + resolutionCode: + description: This field is used to provide resolution code of exception + minLength: 1 + maxLength: 255 + type: string + example: Freezer + resolutionDescription: + description: This field is used to provide resolution description of exception + minLength: 1 + maxLength: 2000 + type: [string, "null"] + example: Freezer will be used for vaccines + statusCode: + description: This field is used to provide status code of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Controllable + statusDescription: + description: This field is used to provide status description of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Controllable + exceptionCreatedDate: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmt: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + exceptionCreatedDateGmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + additionalProperties: false + Gps: + type: object + description: Use this field for shipment tracking + properties: + city: + description: City name where the shipment is currently present + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: Atlanta + country: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Country name where the shipment is currently present + example: United States Of America + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + latitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Latitude + example: "+29.749907" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + longitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Longitude + example: "-95.358421" + additionalProperties: false + HumidityLevel: + type: object + description: Use this field to provide information about the shipment humidity conditions + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + humidity: + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "40" + humidityUOM: + description: Humidity Unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: g/m3 + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + InternationalShipment: + description: Use this field for international shipment info like country and commodity code + type: object + properties: + harmonizedCommodityCode: + description: The international commodity or harmonized code that represents the commodity contained in the invoice line + minLength: 1 + maxLength: 50 + type: [string, "null"] + example: "0701.10" + shipmentExportCountryCode: + description: Country Code of shipment export + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: US + specialInstructions: + description: Any international special instructions required + minLength: 1 + type: [string, "null"] + additionalProperties: false + LightStrength: + description: Light sensor data + type: object + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + light: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Light sensor + example: "20" + lightUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + enum: + - lux + - candles + - lumens + - footcandles + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + ObjectServiceResponse: + description: Service response object containgin details if the shipments were processed successfully or not. + type: object + properties: + errors: + type: [array, "null"] + items: + "$ref": "#/components/schemas/Error" + isCompleted: + description: This field denotes if the request was processed successfully or not + type: boolean + isFaulted: + description: This field denotes if there is any error while precessing the shipments + type: boolean + result: + description: List of shipments received in request with the status if they were processed successfully or not + type: [object, "null"] + additionalProperties: false + OrderDetails: + required: + - customerAccountNumber + - shipmentDetails + type: object + description: Use this section to provide/map info about the order (ex load, shipment etc) + properties: + customerAccountNumber: + minLength: 1 + maxLength: 100 + type: string + pattern: ^[a-zA-Z0-9_]*$ + orderNumber: + minLength: 1 + maxLength: 100 + type: [string, "null"] + customerPONumber: + minLength: 1 + type: [string, "null"] + description: Customer Purchase Order Number + example: "SO1023674" + orderPlacedDate: + minLength: 1 + maxLength: 100 + type: string + format: date-time + example: '2023-07-09T11:07:38.446' + shipmentDetails: + type: array + description: Use this section to provide information about the shipment + maxItems: 500 + items: + "$ref": "#/components/schemas/ShipmentDetail" + additionalProperties: false + PartyDetail: + description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc. + type: object + properties: + city: + minLength: 1 + maxLength: 512 + type: string + description: Party(Shipper, Consignee, etc) city name + example: Atlanta + countryCode: + minLength: 1 + maxLength: 50 + type: string + description: Party(Shipper, Consignee, etc) Country code + example: US + stateCode: + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "GA" + type: + minLength: 1 + maxLength: 10 + type: string + enum: + - Shipper + - Consignee + additionalProperties: false + SC360Interface: + description: Supply chain 360 interface + required: + - docType + - orderDetails + - sourceSystem + type: object + properties: + sbMessageId: + description: Service Bus message id + minLength: 1 + type: [string, "null"] + example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" + docFlow: + minLength: 1 + maxLength: 25 + type: string + description: Field for publishers to populate about the document flow type + enum: + - Inbound + - Outbound + docId: + minLength: 16 + maxLength: 50 + type: string + description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. + docTime: + minLength: 1 + maxLength: 100 + type: string + description: Current Date/Time when message is generated in UTC format + format: date-time + docType: + minLength: 1 + maxLength: 25 + type: string + enum: + - OrderStatus + - Order + docVer: + minLength: 1 + maxLength: 10 + type: string + description: Document version. Current version is 1.0 + transactionType: + minLength: 1 + type: [string, "null"] + orderDetails: + type: array + maxItems: 500 + items: + "$ref": "#/components/schemas/OrderDetails" + originalDocId: + minLength: 1 + maxLength: 50 + type: [string, "null"] + description: Unique Identifier for JSON message at the publisher side. Optional field for message publishers to populate + sourceSystem: + minLength: 1 + maxLength: 50 + type: string + description: source system name + example: "BOMI" + partnerId: + minLength: 1 + type: [string, "null"] + additionalProperties: false + SC360InterfaceSC360IngestRequest: + description: Supply chain 360 interface ingest request + required: + - apiVersion + - request + type: object + properties: + request: + "$ref": "#/components/schemas/SC360Interface" + apiVersion: + minLength: 1 + type: string + enum: + - v1.0 + additionalProperties: false + SC360Response: + description: Supply chain 360 response + required: + - docId + - docType + - messageId + - orderNumber + - shipmentNumber + - shipmentUniquekey + type: object + properties: + messageId: + description: Service bus message id for a shipment + minLength: 1 + type: string + example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" + orderNumber: + description: Unique identifier for the order/load. An order could have multiple shipments. + minLength: 1 + type: string + example: LD123437 + shipmentNumber: + minLength: 1 + type: string + description: Unique identifier of a shipment + example: SN12345678 + shipmentUniquekey: + minLength: 1 + type: string + description: shipmentUniqueKey is used to uniquely identify a shipment + example: BOMI_SN1658566_20230709 + docId: + minLength: 1 + type: string + description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. + example: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: + minLength: 1 + type: string + enum: + - OrderStatus + - Order + isCompleted: + type: boolean + additionalProperties: false + SC360ResponseListServiceResponse: + description: Supply chain 360 response list of process shipments + type: object + properties: + errors: + type: [array, "null"] + items: + "$ref": "#/components/schemas/Error" + isCompleted: + description: This field denotes if the request was processed successfully or not + type: boolean + isFaulted: + description: This field denotes if there is any error while precessing the shipments + type: boolean + result: + description: List of shipments received in request with the status if they were processed successfully or not + type: [array, "null"] + items: + "$ref": "#/components/schemas/SC360Response" + additionalProperties: false + SensorData: + type: object + description: This section is used for capturing sensor level data for the package when the sensor event flag is true + properties: + gps: + "$ref": "#/components/schemas/Gps" + humidityLevel: + "$ref": "#/components/schemas/HumidityLevel" + lightStrength: + "$ref": "#/components/schemas/LightStrength" + shockForce: + "$ref": "#/components/schemas/ShockForce" + temperature: + "$ref": "#/components/schemas/Temperature" + additionalProperties: false + Service: + type: object + description: Service information like service code (ex ground, overnight, international and descriptions) + properties: + carrierServiceCode: + description: Use this field to specify the carrier service level if different than service level + minLength: 1 + maxLength: 255 + type: string + example: Standard + carrierServiceDescription: + description: Description for carrier service level + minLength: 1 + type: [string, "null"] + example: Standard + handlingCode: + description: Shipment package handling instructions code + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Fragile + handlingDescription: + description: Shipment package handling instructions description + minLength: 1 + type: [string, "null"] + example: Fragile content, handle with care + saturdayDeliveryFlag: + minLength: 1 + maxLength: 1 + type: [string, "null"] + enum: + - Y + - N + serviceCode: + description: Code of service level for the shipment + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: GND + serviceDescription: + description: Description for the level of service + minLength: 1 + type: [string, "null"] + example: Ground + additionalProperties: false + ShipUnit: + description: List of shipping units like items, length, width, height, etc + type: object + properties: + dimensionWeight: + description: Shipment Unit Dimensional Weight. This is the estimated weight of the package based on its dimensions. + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "200.00" + dimensionWeightUOM: + description: Dimensional weight unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: kg/dm3 + height: + description: Height of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + heightUOM: + description: Height unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + itemDesciption: + description: Shipment unit items description + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: medical equipments + length: + description: Length of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + lengthUOM: + description: Length unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + weight: + description: Weight of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "20" + weightUOM: + description: Weight unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: kg + width: + description: Widht of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + widthUOM: + description: Width unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + shipmentQuantity: + description: Quantity of items in shipment unit + type: [integer, "null"] + format: int32 + example: 20 + volume: + description: Volume of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "50.0" + volumeUOM: + description: Volume unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: dm3 + additionalProperties: false + ShipmentDetail: + required: + - shipmentNumber + - shipmentPlacedDate + - shipmentUniqueKey + type: object + properties: + activityInformation: + description: Use this to provide info about activities and milestones updates for the shipment. + "$ref": "#/components/schemas/ActivityInformation" + actualPickupDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + billingInformation: + description: Use this field to specify whom the shipment is charged to and descriptions for billing code + "$ref": "#/components/schemas/BillingInformation" + carrier: + description: Use this field to provide info about carrier used for shipment + "$ref": "#/components/schemas/Carrier" + collectOnDeliveryAmount: + minLength: 1 + maxLength: 225 + type: [string, "null"] + collectOnDeliveryCurrency: + minLength: 1 + maxLength: 200 + type: [string, "null"] + description: Currency code of the amount received on delivery + earliestDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + internationalShipment: + "$ref": "#/components/schemas/InternationalShipment" + latestDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + leadShipmentNumber: + minLength: 1 + maxLength: 100 + type: [string, "null"] + description: Use this field to provide key information for the lead shipment in case there are multiple packages in a shipment + partyDetails: + type: [array, "null"] + description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc + items: + "$ref": "#/components/schemas/PartyDetail" + rescheduledDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + scheduledDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + scheduledPickupDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + sensorData: + description: This section is used for capturing sensor level data for the package + "$ref": "#/components/schemas/SensorData" + service: + "$ref": "#/components/schemas/Service" + shipUnits: + type: [array, "null"] + description: List of shipping units like number of items, length, width, height, + items: + "$ref": "#/components/schemas/ShipUnit" + shipmentDescription: + minLength: 1 + maxLength: 1000 + type: [string, "null"] + description: Shipment contents description text + example: fragile material + shipmentNumber: + minLength: 1 + maxLength: 100 + type: string + description: Unique identifier of a shipment + example: SN12345678 + shipmentReferences: + type: [array, "null"] + description: List of reference information about the package + items: + "$ref": "#/components/schemas/ShipmentReference" + specialInformation: + description: Provide any special information about shipment like Hazardous material + "$ref": "#/components/schemas/SpecialInformation" + temperatureCondition: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature condition + example: "Amber" + shipmentPlacedDate: + type: string + format: date-time + carrierShipmentNumber: + type: [array, "null"] + items: + type: string + shipmentUniqueKey: + minLength: 1 + maxLength: 100 + type: string + description: shipmentUniqueKey is used to uniquely identify a shipment + shipmentBookedDate: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + exceptionInformation: + description: This is used to provide additional details about the package delivery exception + "$ref": "#/components/schemas/ExceptionInformation" + additionalProperties: false + ShipmentReference: + type: object + description: List of reference information about the package + properties: + referenceCode: + minLength: 1 + maxLength: 50 + type: [string, "null"] + description: Code that identifies the reference value + example: Order + referenceType: + minLength: 1 + maxLength: 50 + type: string + description: This field is used to specify the type of reference field + example: shipment + referenceValue: + minLength: 1 + maxLength: 255 + type: string + description: Reference value + example: PO12345 + additionalProperties: false + ShockForce: + type: object + description: Has shipment been dropped or otherwise exposed to an impact force that exceeds a predetermined level + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + shock: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Shipment has been dropped or otherwise exposed to an impact force that exceeds a predetermined level + example: "20" + shockUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Shock Unit of measurement + example: "g's" + additionalProperties: false + SpecialInformation: + type: object + description: Provide any special information about shipment like Hazardous material + properties: + hazmatCategoryCode: + minLength: 1 + maxLength: 255 + type: [string, "null"] + description: Hazardous material category code + example: Explosives + hazmatCategoryDescription: + minLength: 1 + maxLength: 1000 + type: [string, "null"] + description: Hazardous material category description + example: Explosives + hazmatFlag: + minLength: 1 + maxLength: 1 + type: [string, "null"] + enum: + - Y + - N + additionalProperties: false + Temperature: + type: object + description: Temperature information of the shipment + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + temperatureInfo: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature value of the container + example: "10" + temperatureUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature unit of measurement + example: "C" + enum: + - C + - F + additionalProperties: false + securitySchemes: + OAuth2ClientCredentialsWithAssertion: + type: oauth2 + description: | + This API uses OAuth 2.0 with mutual TLS for client authentication. + The client must include a client assertion signed with a certificate in the token request to token endpoint + client_assertion_type: urn:ietf:params:oauth:client-assertion-type:jwt-bearer + flows: + clientCredentials: + tokenUrl: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token + scopes: {} +security: +- OAuth2ClientCredentialsWithAssertion: [] + \ No newline at end of file From 7dfaf14415fce9bb9a69d33d4e19c7dacedafbd6 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 13:29:43 -0500 Subject: [PATCH 64/89] Update --- UPSSCSTransportationAPI.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/UPSSCSTransportationAPI.yaml b/UPSSCSTransportationAPI.yaml index c8ac754..aa09bcf 100644 --- a/UPSSCSTransportationAPI.yaml +++ b/UPSSCSTransportationAPI.yaml @@ -7,7 +7,7 @@ info: API to post transportation order data for point to point shipments to allow for a near real time visibility. API supports only standalone transactions and does not support data aggregations or orchestration with different source systems. version: "1.0" tags: - - name: "Transportation" + - name: "UPS SCS Transportation API" description: "Partner Publisher API" servers: - url: https:onlinetools.ups.com/api/transaction-visibility-dashboard/v1 @@ -20,7 +20,7 @@ paths: description: "This API is used to ingest the partner's shipments data into Symphony." operationId: SC360_PublisherAPI_Ingest tags: - - Transportation + - UPS SCS Transportation API security: - OAuth2ClientCredentialsWithAssertion: [] x-slo: @@ -1303,4 +1303,4 @@ components: scopes: {} security: - OAuth2ClientCredentialsWithAssertion: [] - \ No newline at end of file + From a8ff817c56f81566ebb63feabae4fccb680776a8 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 13:48:06 -0500 Subject: [PATCH 65/89] removed --- Direct-to-Mobile.yaml | 1002 ----------------------------------------- 1 file changed, 1002 deletions(-) delete mode 100644 Direct-to-Mobile.yaml diff --git a/Direct-to-Mobile.yaml b/Direct-to-Mobile.yaml deleted file mode 100644 index 288f83c..0000000 --- a/Direct-to-Mobile.yaml +++ /dev/null @@ -1,1002 +0,0 @@ -openapi: 3.1.0 -info: - title: "Direct-to-Mobile API v1" - description: | - The UPS Direct to Mobile program enables retailers, manufacturers, and other - UPS shippers to offer their customers a convenient “No printer? No problem.” package label option for - forward shipments and returns. - - # Key Business Values - - This API provides the capability to participate in the “No Box, No Label” return program. - - The Direct to Mobile API is a paid contract program that supports ALL of the different types of drop-offs (forward AND return shipments) within a single DTM API request. - - - **Label Only** - The drop-off item is required to arrive at the store packed and sealed. - - **No Box No Label** - Does not require the item be pre-packed. The unpacked/loose drop-off item is eligible for the “No - Box No Label / 360 Simple Returns” shipping pak program. - - **Label & Packaging** - Does not require the item be pre-packed. The drop-off item is eligible for a custom The UPS - Store® packaging program. - - # Reference - - Errors - - version: "1.0" -tags: - - name: "Direct-To-Mobile" - description: Provides the capability to participate in the new “No Box, No Label” return program. - -servers: - - url: "https://onlinetools.ups.com/api/ups-store/iship/{version}" - description: URL for OAuth based authentication that can be used for any environment (production, staging, product test) via hosts file. - variables: - version: - default: v1 - enum: - - v1 -paths: - /direct-to-mobile: - post: - summary: Create a Direct to Mobile Dropoff - description: | - Creates a Direct to Mobile (DTM) drop-off entry. This endpoint is used after a shipment has been created in the retailer's manifesting system. - operationId: createDropoff - tags: - - Direct-To-Mobile - security: - - oauth2: [] - parameters: - - name: transId - in: header - style: simple - required: true - description: Unique ID used for dropoff requests. - schema: - type: string - example: dtm20241205111040 - - name: transactionSrc - in: header - style: simple - required: true - description: Identifies the client/source application that is calling. - schema: - type: string - - name: Content-Type - in: header - description: The Content Type header is used to indicate the acceptable body format of the response coming from the API. - required: true - schema: - type: string - example: application/json;type=vnd.iShip.Dropoff - - $ref: "#/components/parameters/x-iship-date" - - $ref: "#/components/parameters/x-iship-CorrelationID" - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/DirectToMobileRequest' - example: - description: "Coffee maker" - fromAddress: - companyName: "Jane Doe" - contactName: "" - address1: "12020 101st Ave NE" - address2: "Apt F1" - address3: "" - city: "Kirkland" - stateProv: "WA" - postalCode: "98034" - country: "US" - phone: "4255554848" - toAddress: - companyName: "Central Perk" - address1: "1234 Returns Way" - address2: "#D4" - address3: null - city: "New York" - stateProv: "NY" - postalCode: "10101" - country: "US" - phone: "4255551234" - dimensions: - units: "inches" - height: 10 - length: 8 - width: 6 - weight: - actual: - units: "lbs" - value: 3.5 - billable: - units: "lbs" - value: 0 - dimensionalWeight: - units: "lbs" - value: "" - chargeMethod: 0 - referenceNumbers: - reference1: "customer reference 1" - reference2: "customer reference 2" - mobileInfo: - mobileId: "RMA0037488" - billMethod: 2 - movementType: 1 - programType: 2 - programRef1: "Central Perk" - programRef2: "" - carrierId: 1 - cod: - amount: null - currencyCode: null - codPayType: null - codType: null - demoFlag: 1 - expiresAtUTC: null - hazardousMaterial: - detail: null - type: null - identification: - type: null - number: null - stateProv: null - country: null - returnsType: 1 - routeCode: null - saturdayDelivery: null - serviceID: 1991 - signatureType: null - sortCode: null - trackingNo: "1ZXX74W59018531040" - voidFlag: 0 - responses: - '200': - description: Successful dropoff creation - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - x-iship-RequestID: - $ref: "#/components/headers/x-iship-RequestID" - x-iship-date: - $ref: "#/components/headers/x-iship-date" - content: - application/json: - schema: - $ref: '#/components/schemas/DirectToMobileResponse' - example: - dropoffOID: "70318a17e84e451ebb80ea97664b7403" - fromAddress: - companyName: "Jane Doe" - address1: "12020 101st Ave NE" - city: "Kirkland" - stateProv: "WA" - postalCode: "98034" - country: "US" - phone: "4255554848" - toAddress: - companyName: "Central Perk" - address1: "1234 Returns Way" - city: "New York" - stateProv: "NY" - postalCode: "10101" - country: "US" - phone: "4255551234" - dimensions: - height: 10 - length: 8 - width: 6 - weight: - actual: - units: "lbs" - value: 3.5 - billable: - units: "lbs" - value: 0 - dimensional: - units: "lbs" - value: 0 - chargeMethod: 0 - manualFlag: 1 - referenceNumbers: - reference1: "RMA0037488" - reference2: "" - reference3: null - reference4: null - mobileInfo: - mobileId: "RMA0037488" - billMethod: 2 - movementType: 1 - programType: 2 - programRef1: "Central Perk" - programRef2: "" - cod: - amount: null - currencyCode: null - payType: null - type: null - hazardousMaterial: - messages: null - type: null - dropOffDocument: - documentPath: "urn:universalapplication1/edop.positiondocuments:Root/Enterprises/Mobile Edop/Mobile Dropoff/Document?docname=mobilereturns&xposfloat=30.0&yposfloat=75.0&symbology=code93&heightfloat=100.0&narrow=15&output=png" - imageOutput: "iVBORw0KGgoAAAANSUhEUgAAAfQAAAIcAQMAAAA65867AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAGUExURQAAAP///6XZn90AAAAJcEhZcwAAPYQAAD2EAdWsr3QAAAQ5SURBVHja7du9biM3EAfwVQScSiIvIAbIC5yruBDEJwmQPoVh+BAFkCEqTdRZT5A0eQiniSVDgNXFZYoUsrxFmkC3i8vdbqA9ToZcfQe3G0oWAvj+05gW9kdryeGA1MoBHRQRPPxhfhjsH/IZ+NH+o2fg4eHh4eHh4eHh4eHh4eHh4eHh4eHhPwY/DARlQVDYgIeHhz+qt082q/krQd6wkdlnfgoeHh7+SJ4jv2hVrbL8ywaCdgMeHh7+Cf0qdndLW13Dw8PDP71fXGSjumwEXuc3eHh4+IO8Wp7f7EFuEcLr/AYPDw/v6XfLlo3sXw14eHj4p/cbRWpxdbTsaFHIFDw8PPxR/KJ+LS7aakTrB2nw8PDwR/OL2Lo62uoaHh4e/om9WHfkYrWR8vn8Gh4eHn4vv33R6vuLu1sreHh4+GP53d3SqiOCh4eHP4rfKFJZvoMSy0bgcf6Dh4eH9/Yb/6Sx+/yMPM5/8PDw8N6+PBQ8PDz8EbxnwMPDw8PDw8PDw8PDw8P/Dz7TWUcaFVSNyhSfhfUDpSqTNNSpGoWVOhv6lIky3zFqFSzlw/aeW6wtj42gR6KIi/YB0ZF7rPABx2xN4EYVtKgwX6aBbJbLfEy7agp0ZicT/tGitE0ulT0hm6zpuyNinyNfdZUI+t7uc9UrxfFRtIfdJtqIaZFnsdOmqbqWT9+VI8q6mV63E+nJOmevkupL+Mi/3nuxcrHY+dD9n2qlPoT55tyw6cUykyzl+bTUv/S+YZyPpR3KgxzbxQpc1J6/6fOn2o3fps+VZxV56Xj3+jw+HdeWm+E9aNp7oea+zg3gRrWCn3Tzv9n2uaPDPu/qnGc+y77KCZO6sL8azZt/n2irFdh/2rtVUpxXJp/zbrN/xfSerK+ny7GT/LPOO0IcVvkFfuaESKqjqcU3v+ousFi/kRMo7h0/tSVkvx6j31E4bi+9v2YenFMd3wfRf5769WYfaqtD4JvV74bnJT6O+dDnr9MhWOejWzpw3LPK/fR+WnuHzmTs0ae/+Wey45RD85HNn+k9co08vUn+D0V3z//ytL51NWPhXfrn6T1heNPYsrSeb5f66NOQ1Pd1Z9Mjq1XovbB9UOucuZeufWT+7z+KesL84+6NSut52pl12/U4ZUo8vqrrS9cP1zal54E+1GYmlOivqv/FbK+sP57Bzw8PDw8PPxz8stNwmBAdFknbap+45e8Xvv5jOj9e0+frH3yjvt44euvkp/Ok8HP010y/Retdra03+TXF/MEvXDRLdN++La18/mX59dT84GNxN92Zm3fqv5+ai+9DPSV+zPPP++mX/51RfD3L9j3/L3Z8nk9eDmT2pZ397Du/f/1vnfDfl5at0kLTv+b6k9m1/84ps/1L9Jk5jnf875O3/V8czfdczz7mhfnxzo7w/0ReH8f/nOxIfiOfiDAv6j9hT9A/qf1YLYhevGAAAAAElFTkSuQmCC" - text: "UNPK-RMA0037488" - identification: - country: null - number: null - stateProv: null - type: null - accountNo: null - billingOptionId: 1 - carrierAccountId: null - carrierId: 1 - createdByAccountNO: "AXFDTR" - createDate: "2021-11-16T01:02:23.387" - demoFlag: 1 - description: null - dropoffGroupOID: null - dropoffStateId: 4 - dropoffTime: null - dropoffTimeUTC: null - dropoffType: null - dropoffTypeAbbr: null - expiresAtUTC: "2022-01-17T08:02:23.387" - notifyFlag: null - numberOfPackages: null - packageNumber: null - pickupDate: "2999-12-31T23:24:00" - pickupOID: "" - receiptPrintFlag: null - returnsType: 1 - routeCode: null - saturdayDelivery: false - serviceID: 1991 - shipDate: null - signatureType: null - sortCode: null - trackingNo: "1ZXX74W59018531040" - transactionTypeId: null - voidFlag: 0 - workstationOID: null - descriptionOfGoods: "Coffee maker" - '400': - $ref: "#/components/responses/BadRequest" - '401': - $ref: "#/components/responses/Unauthorized" - '403': - $ref: "#/components/responses/Forbidden" - '404': - $ref: "#/components/responses/NotFound" - '500': - $ref: "#/components/responses/InternalError" - '503': - $ref: "#/components/responses/ServiceMaintenance" - -components: - securitySchemes: - oauth2: - type: "oauth2" - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token - scopes: {} - headers: - BkndTransId: - description: The backend transaction id. This will be the same as the transId received from client or otherwise a random ID. - schema: - type: string - example: 383f7d397a48 - transId: - description: An identifier unique to the request. - schema: - type: string - minLength: 3 - maxLength: 36 - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - description: Identifies the client/source application that is calling. - schema: - type: string - minLength: 1 - maxLength: 36 - example: Burberry - Content-Type: - description: The Content-Type header provides the client with the actual content/media type of the returned content. - schema: - type: string - example: application/json - APIErrorCode: - description: The API error code. - schema: - type: number - example: 400 - APIErrorMsg: - description: The API error message. - schema: - type: string - example: Invalid token or token is not present. - x-iship-RequestID: - description: All responses returned from the Direct to Mobile API will include a x-iship-RequestID header that contains a unique 32-digit alphanumeric GUID (Globally Unique Identifier) that is assigned by the iShip server. - schema: - type: string - x-iship-date: - description: "Send a standard HTTP Date: header in every request. The Date: header may be blocked on some implementations of HTTP client APIs. If this occurs, use x-iship-date instead" - schema: - type: string - example: "Wed, 10 Nov 2021 21:42:37 GMT" - parameters: - x-iship-date: - name: x-iship-date - in: header - description: "Send a standard HTTP Date: header in every request. The Date: header may be blocked on some implementations of HTTP client APIs. If this occurs, use x-iship-date instead" - required: true - schema: - type: string - example: "Wed, 10 Nov 2021 21:42:37 GMT" - x-iship-CorrelationID: - name: x-iship-CorrelationID - in: header - description: Identifies the client/source application that is calling. - required: false - schema: - type: string - description: Optional GUID for correlating requests - example: "90aac7c1081c4720a8c48a632b144de8" - schemas: - DirectToMobileRequest: - type: object - required: - - description - - fromAddress - - toAddress - - dimensions - - weight - - mobileInfo - - trackingNo - - carrierId - - serviceID - properties: - description: - type: string - maxLength: 35 - description: Merchandise description / package contents. - fromAddress: - $ref: '#/components/schemas/Address' - toAddress: - $ref: '#/components/schemas/Address' - dimensions: - $ref: '#/components/schemas/Dimensions' - weight: - $ref: '#/components/schemas/Weight' - referenceNumbers: - description: Barcode & Text on Label - $ref: '#/components/schemas/ReferenceNumbers' - mobileInfo: - $ref: '#/components/schemas/MobileInfo' - carrierId: - type: integer - description: The value indicates the carrier type. - cod: - $ref: '#/components/schemas/COD' - demoFlag: - type: integer - enum: [0,1] - default: 0 - description: | - 0 : Live Drop Off Package (Default) - 1 : Demo Drop Off Package - expiresAtUTC: - type: string - format: date-time - nullable: true - description: UTC time that Dropoff package will expire. - hazardousMaterial: - $ref: '#/components/schemas/HazardousMaterial' - identification: - $ref: '#/components/schemas/Identification' - returnsType: - type: integer - description: | - 0 : No Return Service (Default) - 13 : Return Service - Print Label - routeCode: - type: string - maxLength: 40 - nullable: true - description: Destination routing code associated with UPS transaction. - saturdayDelivery: - type: integer - nullable: true - description: | - 0 : Not Selected (Default) - 1 : Saturday Delivery Requested - serviceID: - type: integer - description: service ID. - signatureType: - type: integer - nullable: true - description: | - 0 : No Selection / Preference (Default) - 1 : Signature Release - 2 : Signature Required - 3 : Adult Signature Required - sortCode: - type: string - maxLength: 2 - nullable: true - description: Custom Sort Code (Requires UPS Approval) - trackingNo: - type: string - description: Carrier tracking number of dropoff package. - voidFlag: - type: integer - description: | - 0 : Live Package - 1 : Voided Package - - # ADDRESS - Address: - type: object - required: - - companyName - - address1 - - city - - postalCode - - country - properties: - companyName: - type: string - maxLength: 35 - description: The sender's/receiver's personal name or a company name. - contactName: - type: string - maxLength: 35 - description: The sender's/receiver's contact name or attention. - address1: - type: string - maxLength: 35 - description: The sender's/receiver's street address. - address2: - type: string - maxLength: 35 - description: The sender's/receiver's Suite, Apt, Building, etc. - address3: - type: string - maxLength: 35 - nullable: true - description: Additional address information. - city: - type: string - maxLength: 40 - description: The sender's/receiver's city name. - stateProv: - type: string - maxLength: 15 - description: The sender's/receiver's State or Province. - postalCode: - type: string - maxLength: 10 - description: The sender's/receiver's Zip or postal code. - country: - type: string - maxLength: 2 - description: The sender's/receiver's Country or Territory Abbreviation e.g. “CA”, “MX” or “US” - phone: - type: string - maxLength: 25 - description: The sender's/receiver's Telephone number. - - # DIMENSIONS - Dimensions: - type: object - required: - - height - - length - - width - properties: - units: - type: string - enum: [inches, centimeters] - default: inches - height: - type: number - description: The height of the package - length: - type: number - description: The length of the package - width: - type: number - description: The width of the package - - # WEIGHT - Weight: - type: object - properties: - actual: - description: The actual weight of the package. - $ref: '#/components/schemas/WeightClass' - billable: - description: The billable weight of the package. - $ref: '#/components/schemas/WeightClass' - dimensional: - description: The dimensional weight of the package. - $ref: '#/components/schemas/WeightClass' - chargeMethod: - type: integer - description: | - The “chargeMethod” is a required Direct to Mobile API request element. - Actual Weight : 0 - Dimensional Weight : 1 - Oversize Weight : 2 - Letter Weight : 3 - Carrier Pack Billable Weight : 4 - Minimum Billable Weight for Large Package : 5 - Box Weight : 6 - manualFlag: - type: integer - WeightClass: - type: object - required: - - value - properties: - units: - type: string - enum: [lbs, kgs] - default: lbs - value: - type: number - description: Weight value. - default: 0 - - # REFERENCE NUMBERS - ReferenceNumbers: - type: object - properties: - reference1: - type: string - maxLength: 100 - nullable: true - reference2: - type: string - maxLength: 100 - nullable: true - reference3: - type: string - maxLength: 100 - nullable: true - reference4: - type: string - maxLength: 100 - nullable: true - # MOBILE INFO - MobileInfo: - type: object - required: - - mobileId - - programRef1 - properties: - mobileId: - type: string - maxLength: 35 - pattern: ^[a-zA-Z0-9]+$ - description: A unique identifier for the dropoff package. Value must be comprised of unaccented letters (a-z, A-Z) or numbers (0-9). - billMethod: - type: integer - enum: [1,2,3] - description: | - For accounting purposes; the value that identifies how the transactions will be billed and/or the entity responsible for billing. Inquire with iShip as to which value to use. - 1 : The UPS Store Corporate Retail Solutions (CRS) - 2 : value is reserved exclusively for the “No Box No Label” offering - 3 : UPS Solutions - movementType: - type: integer - enum: [1,2] - description: | - The value that identifies the movement of the item/shipment - 1 = Return - 2 = Forward - programType: - type: integer - enum: [1,2] - description: | - The value that identifies either how the item should arrive or how it should be processed when it reaches the drop-off location. - 1 = Label Only - 2 = Label & Packaging - programRef1: - type: string - maxLength: 100 - description: Human-readable retailer or shipper name. - programRef2: - type: string - maxLength: 100 - description: A reference value which is not visible to clerk or customer but can be reflected back in data feed or export. - # COD - COD: - type: object - properties: - amount: - type: number - description: Required when codType is greater than 0. - nullable: true - currencyCode: - type: string - maxLength: 3 - description: ISO 3-character abbreviation “USD” (US Dollar), “MXN” (Mexican Peso), etc. - nullable: true - payType: - type: integer - nullable: true - description: | - Required when codType is greater than 0 - 1 : Guaranteed - 2 : Cash Only - 3 : Any Funds - type: - type: integer - nullable: true - description: | - 0 : Not Selected (Default) - 11 : Regular COD - - # RESPONSE SCHEMA - DirectToMobileResponse: - type: object - properties: - dropoffOID: - type: string - fromAddress: - $ref: '#/components/schemas/Address' - toAddress: - $ref: '#/components/schemas/Address' - dimensions: - $ref: '#/components/schemas/Dimensions' - weight: - $ref: '#/components/schemas/Weight' - referenceNumbers: - $ref: '#/components/schemas/ReferenceNumbers' - mobileInfo: - $ref: '#/components/schemas/MobileInfo' - cod: - $ref: '#/components/schemas/COD' - hazardousMaterial: - $ref: '#/components/schemas/HazardousMaterial' - dropOffDocument: - $ref: '#/components/schemas/DropOffDocument' - identification: - $ref: '#/components/schemas/Identification' - accountNo: - type: string - nullable: true - billingOptionID: - type: integer - enum: [1,2,3,9] - carrierAccountId: - type: string - nullable: true - carrierID: - type: integer - createdByAccountNO: - type: string - nullable: true - createDate: - type: string - nullable: true - demoFlag: - type: integer - description: - type: string - nullable: true - dropoffGroupOID: - type: string - nullable: true - dropoffStateId: - type: integer - nullable: true - dropoffTime: - type: string - nullable: true - dropoffTimeUTC: - type: string - nullable: true - dropoffType: - type: string - nullable: true - dropoffTypeAbbr: - type: string - nullable: true - expiresAtUTC: - type: string - nullable: true - notifyFlag: - type: string - nullable: true - numberOfPackages: - type: string - nullable: true - packageNumber: - type: string - nullable: true - pickupDate: - type: string - nullable: true - pickupOID: - type: string - nullable: true - receiptPrintFlag: - type: string - nullable: true - returnsType: - type: integer - nullable: true - routeCode: - type: string - nullable: true - saturdayDelivery: - type: boolean - nullable: true - serviceID: - type: integer - shipDate: - type: string - nullable: true - signatureType: - type: integer - nullable: true - sortCode: - type: string - nullable: true - trackingNo: - type: string - nullable: true - transactionTypeId: - type: string - nullable: true - voidFlag: - type: integer - nullable: true - workstationOID: - type: string - nullable: true - descriptionOfGoods: - type: string - nullable: true - # DROP OFF DOCUMENT (IMAGE + TEXT) - DropOffDocument: - type: object - properties: - documentPath: - type: string - imageOutput: - type: string - description: Base64 encoded barcode image. - text: - type: string - description: Human-readable barcode text. - # identification - Identification: - type: object - properties: - country: - type: string - nullable: true - number: - type: string - nullable: true - description: Internal Use. - stateProv: - type: string - nullable: true - description: Internal Use. - type: - type: string - nullable: true - description: Internal Use. - # hazardousMaterial - HazardousMaterial: - type: object - properties: - messages: - type: string - nullable: true - type: - type: string - description: Internal Use. - nullable: true - - ErrorResponse: - type: object - description: Response object for errors - properties: - response: - description: Response container to store errors - type: object - properties: - errors: - type: array - description: Unbounded array containing one or more errors - items: - type: object - description: Error entity - properties: - code: - type: integer - description: error code - message: - type: string - description: error message - minLength: 1 - required: - - code - - message - additionalProperties: false - required: - - errors - additionalProperties: false - required: - - response - additionalProperties: false - - responses: - BadRequest: - description: Bad Request - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - example: - response: - errors: - - code: 400 - message: The URI could not be parsed - - Unauthorized: - description: Authentication failed - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - example: - response: - errors: - - code: 401 - message: Authentication failed - - Forbidden: - description: Authorization Failed - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - example: - response: - errors: - - code: 403 - message: Authorization Failed - - NotFound: - description: Unknown URI - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - example: - response: - errors: - - code: 404 - message: The service could not find the resource requested. - InternalError: - description: This is a server-side issue. - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - example: - response: - errors: - - code: 500 - message: The service encountered an error and couldn't continue. - ServiceMaintenance: - description: This error may appear during regular scheduled data center maintenance. - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorResponse' - example: - response: - errors: - - code: 503 - message: Sorry for the inconvenience. The service is down for maintenance. From 7ab6d6114071724634622ba627f2605d5342bd3e Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 13:48:53 -0500 Subject: [PATCH 66/89] removed --- CustomsDetailV2.yaml | 1265 ------------------------------------------ 1 file changed, 1265 deletions(-) delete mode 100644 CustomsDetailV2.yaml diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml deleted file mode 100644 index 80536f6..0000000 --- a/CustomsDetailV2.yaml +++ /dev/null @@ -1,1265 +0,0 @@ -openapi: 3.1.0 -info: - title: Customs Detail API - version: "" - - description: | - ## Product Info - Provides clients with up-to-date compliance requirements for data fields that must be captured during the creation of UPS Brokerage shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page. - - ## Key Business Values - - Ensures clients always receive the latest compliance requirements. - - Allows field collection to be fully managed through configurable user settings. - - Flexible framework eliminates additional code changes as compliance fields evolve. - - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. - -servers: - - url: https://www.livesite.ups.com/trade/compliance/{version} - description: URL for JWT based authentication that can be used for any environment (production, staging, product test) via hosts file. - variables: - version: - default: v2 - enum: - - v2 - - url: https://onlinetools.ups.com/api/trade/compliance/{version} - description: URL for Oauth based authentication that can be used for any environment (production, staging, product test) via hosts file. - variables: - version: - default: v2 - enum: - - v2 - - url: https://wwwcie.ups.com/api/trade/compliance/{version} - description: UPS Production CIE - variables: - version: - default: v2 - enum: - - v2 - -paths: - /content/fields/country-fields: - post: - summary: Validate and/or Submit the Fields - description: This endpoint will provide the ability to validate and/or submit the additional field information for a shipment - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/transactionSrc" - - $ref: "#/components/parameters/Content-Type" - - name: registrationId - in: header - required: false - schema: - type: string - description: Used to confirm prsence of active account for Worldship clients - example: 3DA124234342 - operationId: postCountryFieldData - security: - - oauth2: [] - - oauthCie: [] - - JWTAuth: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsPostFieldsRequestV2" - example: - actionType: save - shipperNumber: 1443YY - trackingNumber: 1Z1443YY0161231327 - shipmentMetaData: - - groupKey: US-IMP-CDC - fields: - - fieldKey: ImportLicenseNumber - regulationSections: - - sectionKey: Bio - fieldValue: "123412351234123" - - groupKey: IN-EXP-CSB - fields: - - fieldKey: CSBType - regulationSections: - - sectionKey: CSB - fieldValue: "3" - - fieldKey: IECCode - regulationSections: - - sectionKey: CSB - fieldValue: "99" - products: - - productId: PART-001 - productDescription: Medical device - commodityCode: "3821000010" - productMetaData: - - groupKey: IN-EXP-CSB - fields: - - fieldKey: Amount - regulationSections: - - sectionKey: CSB - fieldValue: "10" - - fieldKey: CurrencyCode - regulationSections: - - sectionKey: CSB - fieldValue: USD - - groupKey: US-IMP-FDA - fields: - - fieldKey: MnuNa - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: UPS Labs - - fieldKey: MnuAdLn1Te - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "55 Glenlake Pkwy NE" - - fieldKey: MnuAdLn2Te - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "Suite 400" - - fieldKey: MnuAdLn3Te - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "Building C" - - fieldKey: MnuCtyNa - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "Atlanta" - - fieldKey: MnuStPrvCd - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "GA" - - fieldKey: MnuCtyCd - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "US" - - fieldKey: MnuPslCd - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - fieldValue: "30301" - - productId: PART-002 - productDescription: Sample pharma goods - commodityCode: "300490" - productMetaData: - - groupKey: US-IMP-FDA - fields: - - fieldKey: MnuNa - regulationSections: - - sectionKey: Cos - fieldValue: UPS Labs - - fieldKey: MnuPslCd - regulationSections: - - sectionKey: Cos - fieldValue: "30301" - - fieldKey: MnuAdLn1Te - regulationSections: - - sectionKey: Cos - fieldValue: 55 Glenlake Pkwy NE - - fieldKey: MnuCtyNa - regulationSections: - - sectionKey: Cos - fieldValue: Atlanta - - fieldKey: MnuStPrvCd - regulationSections: - - sectionKey: Cos - fieldValue: GA - - fieldKey: MnuCtyCd - regulationSections: - - sectionKey: Cos - fieldValue: US - responses: - "204": - description: Success - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - "400": - $ref: "#/components/responses/BadRequest" - "401": - $ref: "#/components/responses/Unauthorized" - "422": - $ref: "#/components/responses/UnprocessableEntity" - "500": - $ref: "#/components/responses/ServerError" - get: - summary: Returns Required Country Fields - description: This returns an array of fields that are required for the provided import and/or export country - parameters: - - $ref: "#/components/parameters/transId" - - $ref: "#/components/parameters/transactionSrc" - - $ref: "#/components/parameters/Content-Type" - - name: import_country_code - in: query - required: false - schema: - type: - - string - - "null" - description: | - The ISO 3166 country or territory code - from where the shipment is being imported to. If this is omitted then all import fields for all countries will be returned - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: US - - name: export_country_code - in: query - required: false - schema: - type: - - string - - "null" - description: | - The ISO 3166 country or territory code - from where the shipment is being exported from. If this is omitted then all export fields for all countries will be returned - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: IT - - name: locale - in: query - required: false - schema: - type: string - description: "" - minLength: 5 - maxLength: 5 - pattern: ^[a-z]{2}-[A-Z]{2}$ - default: en-US - example: en-US - - name: commodity_codes - in: query - required: false - description: Optional comma-separated list of tariff codes to filter results. - schema: - type: - - string - - "null" - minLength: 1 - maxLength: 2000 - example: "2926400000,3003395000" - operationId: getCountryFieldData - security: - - oauth2: [] - - oauthCie: [] - - JWTAuth: [] - responses: - "200": - description: Success - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - TransId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsGetFieldsSuccessResponseV2" - example: - commodityCodes: - - commodityCode: "2926400000" - regulations: - - regulation: FDA - regulationSections: - - sectionKey: DRU - - commodityCode: "3003395000" - regulations: - - regulation: FDA - regulationSections: - - sectionKey: DRU - fieldGroups: - - countryCode: US - countryName: UNITED STATES OF AMERICA - shipmentType: Import - groupKey: US-IMP-FDA - details: This is for US import FDA fields - regulation: FDA - regulationSections: - - sectionKey: Cos - sectionName: Cosmetics - - sectionKey: Bio - sectionName: Biologics - - sectionKey: Dev - sectionName: Device - - sectionKey: Foo - sectionName: Food - fields: - - sectionKey: MnuNa - label: Manufacturer Name - order: "1" - tooltip: Type of shipping bill to be processed for the shipment - isRequired: C - requirementConditions: - - fieldKey: MnuPslCd - operator: "!=" - value: "" - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerName - level: Product - - sectionKey: MnuPslCd - label: Manufacturer Postal Code - order: "8" - tooltip: The postal code address of the manufacturer for the product - isRequired: Y - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerPostalCode - level: Product - - sectionKey: MnuAdLn1Te - label: Manufacturer Address Line 1 - order: "1" - tooltip: Line 1 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine1 - level: Product - - sectionKey: MnuAdLn2Te - label: Manufacturer Address Line 2 - order: "1" - tooltip: Line 2 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine2 - level: Product - - sectionKey: MnuAdLn3Te - label: Manufacturer Address Line 3 - order: "1" - tooltip: Line 3 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine3 - level: Product - - sectionKey: MnuCtyNa - label: Manufacturer City Name - order: "1" - tooltip: Line 3 of the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerAddressLine3 - level: Product - - sectionKey: MnuStPrvCd - label: Manufacturer State/Province Code - order: "1" - tooltip: The state/province for the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerStateProvinceCode - level: Product - - sectionKey: MnuCtyCd - label: Manufacturer Country Code - order: "1" - tooltip: The country code for the address of the manufacturer for the product - isRequired: N - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerCountryCode - level: Product - - sectionKey: MnuPslCd - label: Manufacturer Postal Code - order: "1" - tooltip: The postal code address of the manufacturer for the product - isRequired: Y - requirementConditions: null - fieldType: textbox - allowedValueCount: 1 - validation: - minLength: null - maxLength: null - errorMessage: Enter a valid value - dataType: Text - regexPattern: null - listValues: [] - regulationSections: - - sectionKey: Cos - - sectionKey: Bio - - sectionKey: Dev - - sectionKey: Foo - keyAlias: ManufacturerPostalCode - level: Product - "401": - $ref: "#/components/responses/Unauthorized" - - "422": - $ref: "#/components/responses/UnprocessableEntity" - - "500": - $ref: "#/components/responses/ServerError" -components: - securitySchemes: - oauth2: - type: oauth2 - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token - scopes: {} - oauthCie: - type: oauth2 - - description: | - Find your Client ID and Secret on your app info page. - 1. Select "Try It" - 2. In the Security section enter your Client ID and Secret - 3. Select "Request Token" - 4. Enter any additional information in the Body and Parameters sections - 5. Select "Send" to execute your API request" - flows: - clientCredentials: - x-tokenEndpointAuthMethod: client_secret_basic - tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} - JWTAuth: - type: "http" - scheme: bearer - bearerFormat: JWT - parameters: - transId: - name: transId - in: header - required: true - schema: - type: string - description: Transaction Id - transactionSrc: - name: transactionSrc - in: header - required: true - schema: - type: string - description: Identifies the clients/source application that is calling - - Content-Type: - name: Content-Type - in: header - required: true - schema: - type: string - description: accepted value application/json - headers: - BkndTransId: - description: The backend transaction id. - schema: - type: string - example: 383f7d397a48 - transId: - description: An identifier unique to the request. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]+$ - maxLength: 512 - example: 0a1b9c2d8e3f7g4h6i5 - transactionSrc: - description: Identifies the client/source application that is calling. - schema: - type: string - pattern: ^[a-zA-Z0-9-.]+$ - - maxLength: 512 - example: UPS.com - Content-Type: - description: The Content-Type header provides the client with the actual content/media type of the returned content. - schema: - type: string - example: application/json - APIErrorCode: - description: The API error code. - schema: - type: string - example: UJ0001 - APIErrorMsg: - description: The API error message. - schema: - type: string - example: Invalid token or token is not present. - responses: - BadRequest: - description: Bad Request - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsErrorResponseV2" - example: - response: - errors: - - code: "105.000" - message: Malformed JSON request - - code: "105.004" - message: Field value is required - description: "VALUE_REQUIRED" - field: "shipperNumber" - value: null - Unauthorized: - description: Unauthorized - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsErrorResponseV2" - example: - response: - errors: - - code: "105.401" - message: Invalid token or token is not present - description: null - field: null - value: null - UnprocessableEntity: - description: Unprocessable Entity - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsErrorResponseV2" - example: - response: - errors: - - code: "105.001" - description: INVALID_FIELD - field: importCountryCode - message: Supplied value was not in the correct range of valid values. - value: USA - ServerError: - description: Server Error - - headers: - BkndTransId: - $ref: "#/components/headers/BkndTransId" - transId: - $ref: "#/components/headers/transId" - transactionSrc: - $ref: "#/components/headers/transactionSrc" - Content-Type: - $ref: "#/components/headers/Content-Type" - APIErrorCode: - $ref: "#/components/headers/APIErrorCode" - APIErrorMessage: - $ref: "#/components/headers/APIErrorMsg" - content: - application/json: - schema: - $ref: "#/components/schemas/CountryFieldsErrorResponseV2" - example: - response: - errors: - - code: "105.500" - message: Internal Server Error - description: INTERNAL_ERROR - field: null - value: null - schemas: - #/content/fields/country-fields - CountryFieldsPostFieldsRequestV2: - type: object - description: Container for the posting of field data - properties: - shipperNumber: - type: string - - description: This represents the shipper account number. Required when actionType is save. - minLength: 6 - maxLength: 6 - example: X5R660 - actionType: - type: string - - description: Specify the intent of the request. 'Save' will inherently perform validation. - enum: - - validate - - save - trackingNumber: - type: string - - description: Tthe lead 1Z number fore the shipment. Required when actionType is save. - minLength: 18 - maxLength: 18 - pattern: ^1Z[0-9A-Z]{16}$ - example: 1Z1234567891234560 - shipmentMetaData: - $ref: "#/components/schemas/CountryFieldsRequestMetaDataV2" - products: - type: array - description: Unbounded list of containers for products included on the shipment being updated - minItems: 1 - items: - type: object - - properties: - productId: - type: string - description: An identifier for the product - minLength: 1 - maxLength: 50 - example: PROD-001 - productDescription: - type: string - description: The description of the product - minLength: 1 - maxLength: 105 - example: Sample pharma goods - commodityCode: - $ref: "#/components/schemas/CountryFieldsCommodityCodeV2" - productMetaData: - $ref: "#/components/schemas/CountryFieldsRequestMetaDataV2" - additionalProperties: false - required: - - productId - - productDescription - - productMetaData - additionalProperties: false - required: - - actionType - CountryFieldsGetFieldsSuccessResponseV2: - type: object - description: Contains commodity code groupings and the detailed field metadata required per country, process, and Regulation. - properties: - commodityCodes: - type: array - description: Unbounded list of commodity codes and their associated compliance Regulations. - items: - type: object - properties: - commodityCode: - $ref: "#/components/schemas/CountryFieldsCommodityCodeV2" - regulations: - type: array - description: Regulations that require additional data for this commodity code. - minItems: 1 - items: - type: object - properties: - regulation: - $ref: "#/components/schemas/CountryFieldsRegulationV2" - regulationSections: - $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" - additionalProperties: false - required: - - regulation - - regulationSections - additionalProperties: false - required: - - commodityCode - - regulations - fieldGroups: - type: array - description: Unbounded list of field group definitions grouped by country, shipment type, and Regulation. - minItems: 1 - items: - type: object - properties: - countryCode: - type: string - description: The ISO 3166 country or territory code the fields pertain to. - minLength: 2 - maxLength: 2 - pattern: ^[A-Z]{2}$ - example: US - countryName: - type: string - description: Country name the fields apply to. - example: UNITED STATES OF AMERICA - shipmentType: - type: string - description: Indicates what direction of movement the fields pertain to. - oneOf: - - title: Fields for import movment - const: Import - - title: Fields for export movement - const: Export - - title: Fields for both movements - const: Both - groupKey: - $ref: "#/components/schemas/CountryFieldsGroupKeyV2" - details: - type: string - description: Provides details on why and when the information is needed. - example: This is for US import FDA fields - regulation: - $ref: "#/components/schemas/CountryFieldsRegulationV2" - regulationSections: - $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" - fields: - type: array - description: Unbounded list of individual field definitions. - minItems: 1 - items: - type: object - properties: - sectionKey: - $ref: "#/components/schemas/CountryFieldsSectionKeyV2" - label: - type: string - description: Human-readable name of the field. - example: Manufacturer Name - order: - type: string - description: Display order for the field. - minLength: 1 - maxLength: 3 - example: "1" - tooltip: - type: - - string - - "null" - description: Tooltip text explaining the field. - example: The name of the manufacturer for the product - isRequired: - type: string - description: Returns the conditionality of the field - oneOf: - - title: "Yes" - const: "Y" - - title: "No" - const: "N" - - title: "Conditional" - description: "If returned there will be at least one requirement condition" - const: "C" - requirementConditions: - type: - - array - - "null" - description: Unbounded array of rules. Conditionally required when is 'isRequired' flag is set. - items: - type: object - description: | - An object containing the specifics of each rule. Order is to be applied - top-down (OR conditions align with the prior rule). - properties: - logicalOperator: - type: string - description: | - Determines how the rules are joined when evaluating the condition if there are multiple rules. - Required for all rules except the first. - enum: - - "AND" - - "OR" - fieldKey: - type: - - string - - "null" - description: The key for the field that this rule is evaluating - example: IN001 - operator: - type: - - string - - "null" - description: The operator used when evaluating the rule - oneOf: - - title: Equals - const: "=" - - title: Greater Than - const: ">" - - title: Less Than - const: "<" - - title: Not Equal To - const: "!=" - value: - type: - - string - - "null" - description: The value used when evaluating the rule - example: CSB V - additionalProperties: false - required: - - fieldKey - - operator - - value - fieldType: - type: string - description: The type of the field, based on available html form inputs - enum: - - textbox - - list - - date - - radio - - checkbox - - textarea - example: textbox - allowedValueCount: - type: integer - description: Number of occurnces allowed for this field - minLength: 1 - maxLength: 2 - default: 1 - - example: 1 - validation: - type: object - description: rule validation object - - properties: - minLength: - type: - - integer - - - "null" - description: The min length allowed for text fields - minLength: 1 - maxLength: 2 - minimum: 1 - maximum: 99 - example: 1 - maxLength: - type: - - integer - - "null" - description: The max length allowed for text fields - minLength: 1 - maxLength: 3 - minimum: 1 - maximum: 100 - example: 10 - errorMessage: - type: - - string - - "null" - description: Error Message - example: Enter a valid alpha numeric value. - dataType: - type: string - description: defines which type of values to look for - oneOf: - - title: Custom - description: user will be required to enter a custom regex pattern - const: Custom - - title: List - description: listValues will need to be populated with a list of possible values for the field - const: List - - title: Email - const: Email - - title: Text - const: Text - - title: Alphanumeric - const: Alphanumeric - - title: Number - const: Number - - title: Date - const: Date - regexPattern: - type: - - string - - "null" - description: | - A regex-based validation pattern for the field which should be applied when validating, - Required when the type is 'custom'. - example: ^[a-zA-Z0-9]+$ - listValues: - type: array - description: Unbounded list of string values to validate against. Required for type 'List' - items: - type: object - description: value to validate against - properties: - displayText: - type: string - description: Value to display in the dropdown for consumers - examples: - - GSTIN (Normal) - - GSTIN (Govt Entities) - - GSTIN (Diplomats) - - PAN Number - - TAN Number - - Passport Number - - Aadhaar Number - - Voter Id - internalValue: - type: string - description: Internal value for each dropdown item that is hidden to consumers - examples: - - GSTIN - - GSTINGE - - GSTIND - - PANNO - - TANNO - - PASSNO - - AADHAARNO - - VID - additionalProperties: false - required: - - displayText - - internalValue - additionalProperties: false - required: - - minLength - - - maxLength - - errorMessage - - dataType - regulationSections: - $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" - keyAlias: - type: - - string - - "null" - description: Alias used to identify the field when mapping to downstream systems. - example: ManufacturerName - level: - type: - - string - - "null" - description: Indicates whether the field applies at the shipment or product level. - enum: - - Shipment - - Product - - example: Product - additionalProperties: false - required: - - order - - sectionKey - - label - - tooltip - - isRequired - - fieldType - - allowedValueCount - - validation - - regulationSections - additionalProperties: false - additionalProperties: false - required: - - countryCode - - shipmentType - - groupKey - - details - - regulation - - regulationSections - - fields - additionalProperties: false - required: - - commodityCodes - - #COMMON - CountryFieldsCommodityCodeV2: - type: string - description: The tariff code for the product for the selected country and process type - minLength: 1 - maxLength: 15 - example: "300490" - CountryFieldsGroupKeyV2: - type: string - description: Field group key returned by the GET endpoint used to scope the shipment metadata payload. - minLength: 1 - maxLength: 50 - example: US-IMP-CDC - CountryFieldsRequestMetaDataV2: - type: array - description: Unbounded list of containers for product metadata groups - minItems: 1 - items: - type: object - properties: - groupKey: - $ref: "#/components/schemas/CountryFieldsGroupKeyV2" - fields: - type: array - description: Unbounded list of key-value pairs describing product fields - minItems: 1 - items: - type: object - properties: - fieldKey: - type: string - description: Identifier for the field. - minLength: 1 - maxLength: 50 - examples: - - ImportLicenseNumber - - CSBType - - IECCode - - Amount - - CurrencyCode - - MnuNa - - MnuAdLn1Te - - MnuAdLn2Te - - MnuAdLn3Te - - MnuCtyNa - - MnuStPrvCd - - MnuCtyCd - - MnuPslCd - regulationSections: - $ref: "#/components/schemas/CountryFieldsRegulationSectionV2" - fieldValue: - type: string - description: Value of the field - minLength: 0 - maxLength: 500 - example: UPS Labs - additionalProperties: false - required: - - fieldKey - - regulationSections - - fieldValue - additionalProperties: false - required: - - fields - CountryFieldsSectionKeyV2: - type: string - description: Identifier for the field. - minLength: 1 - maxLength: 50 - examples: - - Bio - - CSB - - Cos - - Dev - - Foo - CountryFieldsRegulationV2: - type: string - description: Identifier for the compliance Regulation. - minLength: 1 - maxLength: 50 - example: FDA - CountryFieldsRegulationSectionV2: - type: array - description: Unbounded list of regulationSection definitions for this Regulation. - minItems: 1 - items: - type: object - properties: - sectionKey: - description: Identifier for the field. Conditionaly required when sectionName is not present. - $ref: "#/components/schemas/CountryFieldsSectionKeyV2" - sectionName: - type: string - description: Human-readable regulationSection label. Conditionally required when sectionKey is not present. - minLength: 1 - maxLength: 100 - example: Cosmetics - additionalProperties: false - CountryFieldsErrorResponseV2: - type: object - description: Response object for errors - properties: - response: - description: Response container to store errors - type: object - properties: - errors: - type: array - description: Unbounded array containing one or more errors - items: - type: object - description: Error entity - properties: - code: - type: string - description: code for the given message - minLength: 1 - example: "105.002" - message: - type: string - description: the warning or error message to be conveyed - minLength: 1 - example: Supplied Key was not in the correct range. - description: - type: - - string - - "null" - description: Internal description of the error - minLength: 1 - example: INVALID_KEY - field: - type: - - string - - "null" - description: The path to the field causing the error as returned from the backend services. - minLength: 1 - example: shipperNumber - value: - type: - - string - - "null" - description: The value that caused the error - minLength: 1 - example: "789999" - additionalProperties: false - required: - - code - - message - required: - - errors - additionalProperties: false - required: - - response - additionalProperties: false From a6f1ed7cd603f69743675f5c6b740acbf946c97a Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 16:15:24 -0500 Subject: [PATCH 67/89] Add files via upload --- UPSSCSTransportation.yaml | 1306 +++++++++++++++++++++++++++++++++++++ 1 file changed, 1306 insertions(+) create mode 100644 UPSSCSTransportation.yaml diff --git a/UPSSCSTransportation.yaml b/UPSSCSTransportation.yaml new file mode 100644 index 0000000..3929922 --- /dev/null +++ b/UPSSCSTransportation.yaml @@ -0,0 +1,1306 @@ +openapi: 3.1.0 +info: + title: "UPS Partner’s Transportation Data Ingestion API" + description: | + ## Purpose + The Transportation API is used to ingest UPS SCS customer shipments data into Symphony. This data is processed and made visible on Symphony for tracking. + API to post transportation order data for point to point shipments to allow for a near real time visibility. API supports only standalone transactions and does not support data aggregations or orchestration with different source systems. + version: "1.0" +tags: + - name: "UPS SCS Transportation" + description: "Partner Publisher API" +servers: + - url: https:onlinetools.ups.com/api/transaction-visibility-dashboard/v1 + description: This is the Symphony server URL for partner publisher api. + +paths: + "/Ingest": + post: + summary: Ingest partner's shipments data in bulk + description: "This API is used to ingest the partner's shipments data into Symphony." + operationId: SC360_PublisherAPI_Ingest + tags: + - UPS SCS Transportation + security: + - OAuth2ClientCredentialsWithAssertion: [] + x-slo: + availability: "99%" + response_time: + - percentile: 99 + value: "900 ms" + - percentile: 95 + value: "750 ms" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360InterfaceSC360IngestRequest" + examples: + sampleTransportationOrderRequest: + value: + request: + docFlow: 'Inbound' + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + docVer: 1.0.0.0 + orderDetails: + - customerAccountNumber: DEMO + orderNumber: LD123437 + customerPONumber: PO44859478 + orderPlacedDate: '2023-07-09T11:07:38.446' + shipmentDetails: + - activityInformation: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + activityID: Delivered + activityLocation: + city: Houston + country: US + latitude: "+29.749907" + longitude: "-95.358421" + postalCode: '75847' + stateProvince: TX + deliveryInformation: + actualDeliveryDateTime: '2023-08-03 10:13:00.000' + actualDeliveryDateTimegmtOffset: "-04:00" + podSignedBy: John + podSignedOn: '2023-08-03 10:13:00.000' + description: delivered + localDateTime: '2019-08-24T14:15:22Z' + sensorEvent: true + type: activity + actualPickupDateTime: '2019-08-24T14:15:22Z' + billingInformation: + billingTermCode: consignee + billingTermDescription: to be paid by consignee + carrier: + carrierCode: convergence + carrierName: Sample + earliestDeliveryDateTime: '2019-08-24T14:15:22Z' + internationalShipment: + harmonizedCommodityCode: + shipmentExportCountryCode: + specialInstructions: + latestDeliveryDateTime: '2019-08-24T14:15:22Z' + leadShipmentNumber: SN4765746545 + partyDetails: + - city: CLEVELAND + countryCode: US + stateCode: 'GA' + type: Shipper + - city: Atlanta + countryCode: US + stateCode: 'GA' + type: Consignee + rescheduledDeliveryDateTime: '2019-08-24T14:15:22Z' + scheduledDeliveryDateTime: '2019-08-24T14:15:22Z' + scheduledPickupDateTime: '2019-08-24T14:15:22Z' + sensorData: + gps: + city: Houston + country: US + latitude: "+29.749907" + longitude: "-95.358421" + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + humidityLevel: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + humidity: '40' + humidityUOM: g/m3 + localDateTime: + lightStrength: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + light: '100' + lightUOM: lux + localDateTime: + shockForce: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + shock: '10' + shockUOM: g + temperature: + gmtDateTime: '2019-08-24T14:15:22Z' + gmtOffset: "-04:00" + localDateTime: + temperatureInfo: '10' + temperatureUOM: C + service: + carrierServiceCode: Standard + carrierServiceDescription: Standard + handlingCode: + handlingDescription: + saturdayDeliveryFlag: Y + serviceCode: Ground + serviceDescription: Ground + shipUnits: + - dimensionWeight: '100' + dimensionWeightUOM: kg + height: '2.0' + heightUOM: m + itemDesciption: medical equipment + length: '5.0' + lengthUOM: m + weight: '50' + weightUOM: kg + width: '5.0' + widthUOM: m + shipmentQuantity: 100 + volume: '50.0' + volumeUOM: dm3 + shipmentDescription: Vaccination + shipmentNumber: SN1658566 + shipmentReferences: + - referenceType: Order + referenceValue: SO67890 + specialInformation: + hazmatCategoryCode: Explosives + hazmatCategoryDescription: Explosives + hazmatFlag: 'Y' + temperatureCondition: cold + shipmentPlacedDate: '2019-08-24T14:15:22Z' + carrierShipmentNumber: + - 1Z7Y47110445061158 + - 1Z0445067Y47111148 + shipmentUniqueKey: DEMO_SN1658566_20230709 + shipmentBookedDate: '2019-08-24T14:15:22Z' + exceptionInformation: + exceptionType: Damaged + reasonCode: Damaged due to weather + reasonDescription: Damaged due to weather + resolutionCode: Damaged + resolutionDescription: + statusCode: + statusDescription: Damaged delivery + exceptionCreatedDate: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmt: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmtOffset: "-04:00" + originalDocId: 2767bc53-060c-46d7-bc66-739a09216b35 + sourceSystem: PartnerA + apiVersion: v1.0 + + + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360ResponseListServiceResponse" + examples: + sampleTransportationOrderSuccessResponse: + value: + errors: + - code: + message: + source: + isCompleted: true + isFaulted: false + result: + - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 + orderNumber: LD123437 + shipmentNumber: SN1658566 + shipmentUniquekey: DEMO_SN1658566_20230709 + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + isCompleted: true + '207': + description: Multi-Status Success Response + content: + application/json: + schema: + "$ref": "#/components/schemas/SC360ResponseListServiceResponse" + examples: + sampleTransportationOrderSuccessResponse: + value: + errors: + - code: + message: + source: + isCompleted: true + isFaulted: false + result: + - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 + orderNumber: LD123437 + shipmentNumber: SN1658566 + shipmentUniquekey: DEMO_SN1658566_20230709 + docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: Order + isCompleted: true + - messageId: a9ea93db-1e51-492f-83c4-d864c95db056 + orderNumber: LD123438 + shipmentNumber: SN1658567 + shipmentUniquekey: DEMO_SN1658566_20230710 + docId: 62551ca8-36c8-4655-84f1-1459440ee9ee + docType: Order + isCompleted: false + '400': + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '400' + message: One or more required property is not provided value + source: shipmentUniqueKey + isCompleted: true + isFaulted: true + result: + '401': + description: Authorization Error + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '401' + message: Unauthorized + source: + isCompleted: true + isFaulted: true + result: + '500': + description: Server Error + content: + application/json: + schema: + "$ref": "#/components/schemas/ObjectServiceResponse" + examples: + sampleTransportationOrderErrorResponse: + value: + errors: + - code: '500' + message: Unexpected server error has occurred. Please try again after some time. + source: + isCompleted: true + isFaulted: true + result: +components: + schemas: + ActivityInformation: + type: object + description: Use this to provide info about activities and milestones updates for the shipment. + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2023-07-09T11:07:38.446' + gmtOffset: + minLength: 1 + maxLength: 20 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + activityID: + description: Unique identifier for the activity + minLength: 1 + maxLength: 128 + type: [string, "null"] + example: Delivered + activityLocation: + description: Location details of the activity + "$ref": "#/components/schemas/ActivityLocation" + activitySubType: + description: Optional field used to specify additional details for the activity + minLength: 1 + maxLength: 250 + type: [string, "null"] + example: OnTime + activitySubTypeDescription: + description: Field used to specify additional details for the activity sub type + minLength: 1 + maxLength: 250 + type: [string, "null"] + deliveryInformation: + description: This field is used to capture any details about package delivery + "$ref": "#/components/schemas/DeliveryInformation" + description: + minLength: 1 + maxLength: 250 + type: string + description: activity description + example: Package delivered to consignee + localDateTime: + minLength: 1 + maxLength: 100 + type: string + format: date-time + sensorEvent: + description: Use this flag to specify if this activity is a result of sensor event + type: [boolean, "null"] + type: + description: This field is used to specify the type of activity or event + minLength: 1 + maxLength: 25 + type: string + additionalProperties: true + ActivityLocation: + type: object + properties: + city: + description: City name where the activity generated + minLength: 1 + maxLength: 512 + type: string + example: Atlanta + country: + description: Country name where the activity generated + minLength: 1 + maxLength: 512 + type: string + example: United States Of America + latitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Latitude + example: "+29.749907" + longitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Longitude + example: "-95.358421" + postalCode: + minLength: 1 + maxLength: 25 + type: [string, "null"] + stateProvince: + minLength: 1 + maxLength: 512 + type: [string, "null"] + example: "GA" + additionalProperties: false + BillingInformation: + type: object + description: Use this field to specify whom the shipment is charged to and descriptions for billing code + properties: + billingTermCode: + description: Use this field to specify whom the shipment is charged to (consignee, shipper, third party) + minLength: 1 + maxLength: 10 + type: [string, "null"] + example: ThirdParty + billingTermDescription: + description: Descriptions for billing code + minLength: 1 + maxLength: 1000 + type: [string, "null"] + example: Paid by third party + additionalProperties: false + Carrier: + type: object + description: Use this field to provide info about carrier used for shipment + properties: + carrierCode: + description: Carrier code of carrier used for shipment + minLength: 1 + maxLength: 50 + type: [string, "null"] + example: UGFF + carrierName: + minLength: 1 + maxLength: 255 + type: [string, "null"] + carrierType: + description: Carrier type of carrier used for shipment + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Freight + additionalProperties: false + DeliveryInformation: + type: object + description: This field is used to capture any details about package delivery + properties: + actualDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2023-07-09T11:07:38.446' + actualDeliveryDateTimegmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: actual delivery datetime gmt offset + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + podSignatureImage: + minLength: 1 + type: [string, "null"] + format: base64encodedstring + podSignatureText: + minLength: 1 + type: [string, "null"] + podSignedBy: + minLength: 1 + maxLength: 500 + type: [string, "null"] + example: "John" + podSignedOn: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + Error: + type: object + properties: + code: + minLength: 1 + maxLength: 500 + type: [string, "null"] + message: + minLength: 1 + maxLength: 500 + type: [string, "null"] + source: + description: Source method name from where the exception is generated + minLength: 1 + maxLength: 500 + type: [string, "null"] + additionalProperties: false + ExceptionInformation: + type: object + description: This is used to provide additional details about the package delivery exception + properties: + exceptionType: + description: This field is used to provide type of exception + minLength: 1 + maxLength: 255 + type: string + example: Damaged + reasonCode: + description: This field is used to provide reason code of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Weather + reasonDescription: + description: This field is used to provide reason description of exception + minLength: 1 + maxLength: 2000 + type: [string, "null"] + example: Hot weather + resolutionCode: + description: This field is used to provide resolution code of exception + minLength: 1 + maxLength: 255 + type: string + example: Freezer + resolutionDescription: + description: This field is used to provide resolution description of exception + minLength: 1 + maxLength: 2000 + type: [string, "null"] + example: Freezer will be used for vaccines + statusCode: + description: This field is used to provide status code of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Controllable + statusDescription: + description: This field is used to provide status description of exception + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Controllable + exceptionCreatedDate: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + exceptionCreatedDateGmt: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + exceptionCreatedDateGmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + additionalProperties: false + Gps: + type: object + description: Use this field for shipment tracking + properties: + city: + description: City name where the shipment is currently present + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: Atlanta + country: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Country name where the shipment is currently present + example: United States Of America + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + latitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Latitude + example: "+29.749907" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + longitude: + minLength: 1 + maxLength: 20 + type: [string, "null"] + description: Longitude + example: "-95.358421" + additionalProperties: false + HumidityLevel: + type: object + description: Use this field to provide information about the shipment humidity conditions + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + humidity: + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "40" + humidityUOM: + description: Humidity Unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: g/m3 + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + InternationalShipment: + description: Use this field for international shipment info like country and commodity code + type: object + properties: + harmonizedCommodityCode: + description: The international commodity or harmonized code that represents the commodity contained in the invoice line + minLength: 1 + maxLength: 50 + type: [string, "null"] + example: "0701.10" + shipmentExportCountryCode: + description: Country Code of shipment export + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: US + specialInstructions: + description: Any international special instructions required + minLength: 1 + type: [string, "null"] + additionalProperties: false + LightStrength: + description: Light sensor data + type: object + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + light: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Light sensor + example: "20" + lightUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + enum: + - lux + - candles + - lumens + - footcandles + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + additionalProperties: false + ObjectServiceResponse: + description: Service response object containgin details if the shipments were processed successfully or not. + type: object + properties: + errors: + type: [array, "null"] + items: + "$ref": "#/components/schemas/Error" + isCompleted: + description: This field denotes if the request was processed successfully or not + type: boolean + isFaulted: + description: This field denotes if there is any error while precessing the shipments + type: boolean + result: + description: List of shipments received in request with the status if they were processed successfully or not + type: [object, "null"] + additionalProperties: false + OrderDetails: + required: + - customerAccountNumber + - shipmentDetails + type: object + description: Use this section to provide/map info about the order (ex load, shipment etc) + properties: + customerAccountNumber: + minLength: 1 + maxLength: 100 + type: string + pattern: ^[a-zA-Z0-9_]*$ + orderNumber: + minLength: 1 + maxLength: 100 + type: [string, "null"] + customerPONumber: + minLength: 1 + type: [string, "null"] + description: Customer Purchase Order Number + example: "SO1023674" + orderPlacedDate: + minLength: 1 + maxLength: 100 + type: string + format: date-time + example: '2023-07-09T11:07:38.446' + shipmentDetails: + type: array + description: Use this section to provide information about the shipment + maxItems: 500 + items: + "$ref": "#/components/schemas/ShipmentDetail" + additionalProperties: false + PartyDetail: + description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc. + type: object + properties: + city: + minLength: 1 + maxLength: 512 + type: string + description: Party(Shipper, Consignee, etc) city name + example: Atlanta + countryCode: + minLength: 1 + maxLength: 50 + type: string + description: Party(Shipper, Consignee, etc) Country code + example: US + stateCode: + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "GA" + type: + minLength: 1 + maxLength: 10 + type: string + enum: + - Shipper + - Consignee + additionalProperties: false + SC360Interface: + description: Supply chain 360 interface + required: + - docType + - orderDetails + - sourceSystem + type: object + properties: + sbMessageId: + description: Service Bus message id + minLength: 1 + type: [string, "null"] + example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" + docFlow: + minLength: 1 + maxLength: 25 + type: string + description: Field for publishers to populate about the document flow type + enum: + - Inbound + - Outbound + docId: + minLength: 16 + maxLength: 50 + type: string + description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. + docTime: + minLength: 1 + maxLength: 100 + type: string + description: Current Date/Time when message is generated in UTC format + format: date-time + docType: + minLength: 1 + maxLength: 25 + type: string + enum: + - OrderStatus + - Order + docVer: + minLength: 1 + maxLength: 10 + type: string + description: Document version. Current version is 1.0 + transactionType: + minLength: 1 + type: [string, "null"] + orderDetails: + type: array + maxItems: 500 + items: + "$ref": "#/components/schemas/OrderDetails" + originalDocId: + minLength: 1 + maxLength: 50 + type: [string, "null"] + description: Unique Identifier for JSON message at the publisher side. Optional field for message publishers to populate + sourceSystem: + minLength: 1 + maxLength: 50 + type: string + description: source system name + example: "BOMI" + partnerId: + minLength: 1 + type: [string, "null"] + additionalProperties: false + SC360InterfaceSC360IngestRequest: + description: Supply chain 360 interface ingest request + required: + - apiVersion + - request + type: object + properties: + request: + "$ref": "#/components/schemas/SC360Interface" + apiVersion: + minLength: 1 + type: string + enum: + - v1.0 + additionalProperties: false + SC360Response: + description: Supply chain 360 response + required: + - docId + - docType + - messageId + - orderNumber + - shipmentNumber + - shipmentUniquekey + type: object + properties: + messageId: + description: Service bus message id for a shipment + minLength: 1 + type: string + example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" + orderNumber: + description: Unique identifier for the order/load. An order could have multiple shipments. + minLength: 1 + type: string + example: LD123437 + shipmentNumber: + minLength: 1 + type: string + description: Unique identifier of a shipment + example: SN12345678 + shipmentUniquekey: + minLength: 1 + type: string + description: shipmentUniqueKey is used to uniquely identify a shipment + example: BOMI_SN1658566_20230709 + docId: + minLength: 1 + type: string + description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. + example: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb + docType: + minLength: 1 + type: string + enum: + - OrderStatus + - Order + isCompleted: + type: boolean + additionalProperties: false + SC360ResponseListServiceResponse: + description: Supply chain 360 response list of process shipments + type: object + properties: + errors: + type: [array, "null"] + items: + "$ref": "#/components/schemas/Error" + isCompleted: + description: This field denotes if the request was processed successfully or not + type: boolean + isFaulted: + description: This field denotes if there is any error while precessing the shipments + type: boolean + result: + description: List of shipments received in request with the status if they were processed successfully or not + type: [array, "null"] + items: + "$ref": "#/components/schemas/SC360Response" + additionalProperties: false + SensorData: + type: object + description: This section is used for capturing sensor level data for the package when the sensor event flag is true + properties: + gps: + "$ref": "#/components/schemas/Gps" + humidityLevel: + "$ref": "#/components/schemas/HumidityLevel" + lightStrength: + "$ref": "#/components/schemas/LightStrength" + shockForce: + "$ref": "#/components/schemas/ShockForce" + temperature: + "$ref": "#/components/schemas/Temperature" + additionalProperties: false + Service: + type: object + description: Service information like service code (ex ground, overnight, international and descriptions) + properties: + carrierServiceCode: + description: Use this field to specify the carrier service level if different than service level + minLength: 1 + maxLength: 255 + type: string + example: Standard + carrierServiceDescription: + description: Description for carrier service level + minLength: 1 + type: [string, "null"] + example: Standard + handlingCode: + description: Shipment package handling instructions code + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: Fragile + handlingDescription: + description: Shipment package handling instructions description + minLength: 1 + type: [string, "null"] + example: Fragile content, handle with care + saturdayDeliveryFlag: + minLength: 1 + maxLength: 1 + type: [string, "null"] + enum: + - Y + - N + serviceCode: + description: Code of service level for the shipment + minLength: 1 + maxLength: 255 + type: [string, "null"] + example: GND + serviceDescription: + description: Description for the level of service + minLength: 1 + type: [string, "null"] + example: Ground + additionalProperties: false + ShipUnit: + description: List of shipping units like items, length, width, height, etc + type: object + properties: + dimensionWeight: + description: Shipment Unit Dimensional Weight. This is the estimated weight of the package based on its dimensions. + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "200.00" + dimensionWeightUOM: + description: Dimensional weight unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: kg/dm3 + height: + description: Height of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + heightUOM: + description: Height unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + itemDesciption: + description: Shipment unit items description + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: medical equipments + length: + description: Length of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + lengthUOM: + description: Length unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + weight: + description: Weight of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "20" + weightUOM: + description: Weight unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: kg + width: + description: Widht of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "25.10" + widthUOM: + description: Width unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: cm + shipmentQuantity: + description: Quantity of items in shipment unit + type: [integer, "null"] + format: int32 + example: 20 + volume: + description: Volume of the shipment package unit + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: "50.0" + volumeUOM: + description: Volume unit of measurement + minLength: 1 + maxLength: 25 + type: [string, "null"] + example: dm3 + additionalProperties: false + ShipmentDetail: + required: + - shipmentNumber + - shipmentPlacedDate + - shipmentUniqueKey + type: object + properties: + activityInformation: + description: Use this to provide info about activities and milestones updates for the shipment. + "$ref": "#/components/schemas/ActivityInformation" + actualPickupDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + billingInformation: + description: Use this field to specify whom the shipment is charged to and descriptions for billing code + "$ref": "#/components/schemas/BillingInformation" + carrier: + description: Use this field to provide info about carrier used for shipment + "$ref": "#/components/schemas/Carrier" + collectOnDeliveryAmount: + minLength: 1 + maxLength: 225 + type: [string, "null"] + collectOnDeliveryCurrency: + minLength: 1 + maxLength: 200 + type: [string, "null"] + description: Currency code of the amount received on delivery + earliestDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + internationalShipment: + "$ref": "#/components/schemas/InternationalShipment" + latestDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + example: '2019-08-24T14:15:22Z' + leadShipmentNumber: + minLength: 1 + maxLength: 100 + type: [string, "null"] + description: Use this field to provide key information for the lead shipment in case there are multiple packages in a shipment + partyDetails: + type: [array, "null"] + description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc + items: + "$ref": "#/components/schemas/PartyDetail" + rescheduledDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + scheduledDeliveryDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + scheduledPickupDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + sensorData: + description: This section is used for capturing sensor level data for the package + "$ref": "#/components/schemas/SensorData" + service: + "$ref": "#/components/schemas/Service" + shipUnits: + type: [array, "null"] + description: List of shipping units like number of items, length, width, height, + items: + "$ref": "#/components/schemas/ShipUnit" + shipmentDescription: + minLength: 1 + maxLength: 1000 + type: [string, "null"] + description: Shipment contents description text + example: fragile material + shipmentNumber: + minLength: 1 + maxLength: 100 + type: string + description: Unique identifier of a shipment + example: SN12345678 + shipmentReferences: + type: [array, "null"] + description: List of reference information about the package + items: + "$ref": "#/components/schemas/ShipmentReference" + specialInformation: + description: Provide any special information about shipment like Hazardous material + "$ref": "#/components/schemas/SpecialInformation" + temperatureCondition: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature condition + example: "Amber" + shipmentPlacedDate: + type: string + format: date-time + carrierShipmentNumber: + type: [array, "null"] + items: + type: string + shipmentUniqueKey: + minLength: 1 + maxLength: 100 + type: string + description: shipmentUniqueKey is used to uniquely identify a shipment + shipmentBookedDate: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + exceptionInformation: + description: This is used to provide additional details about the package delivery exception + "$ref": "#/components/schemas/ExceptionInformation" + additionalProperties: false + ShipmentReference: + type: object + description: List of reference information about the package + properties: + referenceCode: + minLength: 1 + maxLength: 50 + type: [string, "null"] + description: Code that identifies the reference value + example: Order + referenceType: + minLength: 1 + maxLength: 50 + type: string + description: This field is used to specify the type of reference field + example: shipment + referenceValue: + minLength: 1 + maxLength: 255 + type: string + description: Reference value + example: PO12345 + additionalProperties: false + ShockForce: + type: object + description: Has shipment been dropped or otherwise exposed to an impact force that exceeds a predetermined level + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + shock: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Shipment has been dropped or otherwise exposed to an impact force that exceeds a predetermined level + example: "20" + shockUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Shock Unit of measurement + example: "g's" + additionalProperties: false + SpecialInformation: + type: object + description: Provide any special information about shipment like Hazardous material + properties: + hazmatCategoryCode: + minLength: 1 + maxLength: 255 + type: [string, "null"] + description: Hazardous material category code + example: Explosives + hazmatCategoryDescription: + minLength: 1 + maxLength: 1000 + type: [string, "null"] + description: Hazardous material category description + example: Explosives + hazmatFlag: + minLength: 1 + maxLength: 1 + type: [string, "null"] + enum: + - Y + - N + additionalProperties: false + Temperature: + type: object + description: Temperature information of the shipment + properties: + gmtDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + gmtOffset: + minLength: 1 + maxLength: 25 + type: [string, "null"] + pattern: '[+-][0-9]{2}:[0-9]{2}\b' + example: "-04:00" + localDateTime: + minLength: 1 + maxLength: 100 + type: [string, "null"] + format: date-time + temperatureInfo: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature value of the container + example: "10" + temperatureUOM: + minLength: 1 + maxLength: 25 + type: [string, "null"] + description: Temperature unit of measurement + example: "C" + enum: + - C + - F + additionalProperties: false + securitySchemes: + OAuth2ClientCredentialsWithAssertion: + type: oauth2 + description: | + This API uses OAuth 2.0 with mutual TLS for client authentication. + The client must include a client assertion signed with a certificate in the token request to token endpoint + client_assertion_type: urn:ietf:params:oauth:client-assertion-type:jwt-bearer + flows: + clientCredentials: + tokenUrl: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token + scopes: {} +security: +- OAuth2ClientCredentialsWithAssertion: [] + \ No newline at end of file From cb52e10c4e81813ff597873af0a9f6786b7825d3 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 3 Feb 2026 16:15:44 -0500 Subject: [PATCH 68/89] Delete UPSSCSTransportationAPI.yaml --- UPSSCSTransportationAPI.yaml | 1306 ---------------------------------- 1 file changed, 1306 deletions(-) delete mode 100644 UPSSCSTransportationAPI.yaml diff --git a/UPSSCSTransportationAPI.yaml b/UPSSCSTransportationAPI.yaml deleted file mode 100644 index aa09bcf..0000000 --- a/UPSSCSTransportationAPI.yaml +++ /dev/null @@ -1,1306 +0,0 @@ -openapi: 3.1.0 -info: - title: "UPS Partner’s Transportation Data Ingestion API" - description: | - ## Purpose - The Transportation API is used to ingest UPS SCS customer shipments data into Symphony. This data is processed and made visible on Symphony for tracking. - API to post transportation order data for point to point shipments to allow for a near real time visibility. API supports only standalone transactions and does not support data aggregations or orchestration with different source systems. - version: "1.0" -tags: - - name: "UPS SCS Transportation API" - description: "Partner Publisher API" -servers: - - url: https:onlinetools.ups.com/api/transaction-visibility-dashboard/v1 - description: This is the Symphony server URL for partner publisher api. - -paths: - "/Ingest": - post: - summary: Ingest partner's shipments data in bulk - description: "This API is used to ingest the partner's shipments data into Symphony." - operationId: SC360_PublisherAPI_Ingest - tags: - - UPS SCS Transportation API - security: - - OAuth2ClientCredentialsWithAssertion: [] - x-slo: - availability: "99%" - response_time: - - percentile: 99 - value: "900 ms" - - percentile: 95 - value: "750 ms" - requestBody: - content: - application/json: - schema: - "$ref": "#/components/schemas/SC360InterfaceSC360IngestRequest" - examples: - sampleTransportationOrderRequest: - value: - request: - docFlow: 'Inbound' - docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: Order - docVer: 1.0.0.0 - orderDetails: - - customerAccountNumber: DEMO - orderNumber: LD123437 - customerPONumber: PO44859478 - orderPlacedDate: '2023-07-09T11:07:38.446' - shipmentDetails: - - activityInformation: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - activityID: Delivered - activityLocation: - city: Houston - country: US - latitude: "+29.749907" - longitude: "-95.358421" - postalCode: '75847' - stateProvince: TX - deliveryInformation: - actualDeliveryDateTime: '2023-08-03 10:13:00.000' - actualDeliveryDateTimegmtOffset: "-04:00" - podSignedBy: John - podSignedOn: '2023-08-03 10:13:00.000' - description: delivered - localDateTime: '2019-08-24T14:15:22Z' - sensorEvent: true - type: activity - actualPickupDateTime: '2019-08-24T14:15:22Z' - billingInformation: - billingTermCode: consignee - billingTermDescription: to be paid by consignee - carrier: - carrierCode: convergence - carrierName: Sample - earliestDeliveryDateTime: '2019-08-24T14:15:22Z' - internationalShipment: - harmonizedCommodityCode: - shipmentExportCountryCode: - specialInstructions: - latestDeliveryDateTime: '2019-08-24T14:15:22Z' - leadShipmentNumber: SN4765746545 - partyDetails: - - city: CLEVELAND - countryCode: US - stateCode: 'GA' - type: Shipper - - city: Atlanta - countryCode: US - stateCode: 'GA' - type: Consignee - rescheduledDeliveryDateTime: '2019-08-24T14:15:22Z' - scheduledDeliveryDateTime: '2019-08-24T14:15:22Z' - scheduledPickupDateTime: '2019-08-24T14:15:22Z' - sensorData: - gps: - city: Houston - country: US - latitude: "+29.749907" - longitude: "-95.358421" - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - localDateTime: - humidityLevel: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - humidity: '40' - humidityUOM: g/m3 - localDateTime: - lightStrength: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - light: '100' - lightUOM: lux - localDateTime: - shockForce: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - localDateTime: - shock: '10' - shockUOM: g - temperature: - gmtDateTime: '2019-08-24T14:15:22Z' - gmtOffset: "-04:00" - localDateTime: - temperatureInfo: '10' - temperatureUOM: C - service: - carrierServiceCode: Standard - carrierServiceDescription: Standard - handlingCode: - handlingDescription: - saturdayDeliveryFlag: Y - serviceCode: Ground - serviceDescription: Ground - shipUnits: - - dimensionWeight: '100' - dimensionWeightUOM: kg - height: '2.0' - heightUOM: m - itemDesciption: medical equipment - length: '5.0' - lengthUOM: m - weight: '50' - weightUOM: kg - width: '5.0' - widthUOM: m - shipmentQuantity: 100 - volume: '50.0' - volumeUOM: dm3 - shipmentDescription: Vaccination - shipmentNumber: SN1658566 - shipmentReferences: - - referenceType: Order - referenceValue: SO67890 - specialInformation: - hazmatCategoryCode: Explosives - hazmatCategoryDescription: Explosives - hazmatFlag: 'Y' - temperatureCondition: cold - shipmentPlacedDate: '2019-08-24T14:15:22Z' - carrierShipmentNumber: - - 1Z7Y47110445061158 - - 1Z0445067Y47111148 - shipmentUniqueKey: DEMO_SN1658566_20230709 - shipmentBookedDate: '2019-08-24T14:15:22Z' - exceptionInformation: - exceptionType: Damaged - reasonCode: Damaged due to weather - reasonDescription: Damaged due to weather - resolutionCode: Damaged - resolutionDescription: - statusCode: - statusDescription: Damaged delivery - exceptionCreatedDate: '2019-08-24T14:15:22Z' - exceptionCreatedDateGmt: '2019-08-24T14:15:22Z' - exceptionCreatedDateGmtOffset: "-04:00" - originalDocId: 2767bc53-060c-46d7-bc66-739a09216b35 - sourceSystem: PartnerA - apiVersion: v1.0 - - - responses: - '200': - description: Success - content: - application/json: - schema: - "$ref": "#/components/schemas/SC360ResponseListServiceResponse" - examples: - sampleTransportationOrderSuccessResponse: - value: - errors: - - code: - message: - source: - isCompleted: true - isFaulted: false - result: - - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 - orderNumber: LD123437 - shipmentNumber: SN1658566 - shipmentUniquekey: DEMO_SN1658566_20230709 - docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: Order - isCompleted: true - '207': - description: Multi-Status Success Response - content: - application/json: - schema: - "$ref": "#/components/schemas/SC360ResponseListServiceResponse" - examples: - sampleTransportationOrderSuccessResponse: - value: - errors: - - code: - message: - source: - isCompleted: true - isFaulted: false - result: - - messageId: 27628ba3-6996-4c01-a0f5-0d4c6ac2d337 - orderNumber: LD123437 - shipmentNumber: SN1658566 - shipmentUniquekey: DEMO_SN1658566_20230709 - docId: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: Order - isCompleted: true - - messageId: a9ea93db-1e51-492f-83c4-d864c95db056 - orderNumber: LD123438 - shipmentNumber: SN1658567 - shipmentUniquekey: DEMO_SN1658566_20230710 - docId: 62551ca8-36c8-4655-84f1-1459440ee9ee - docType: Order - isCompleted: false - '400': - description: Bad Request - content: - application/json: - schema: - "$ref": "#/components/schemas/ObjectServiceResponse" - examples: - sampleTransportationOrderErrorResponse: - value: - errors: - - code: '400' - message: One or more required property is not provided value - source: shipmentUniqueKey - isCompleted: true - isFaulted: true - result: - '401': - description: Authorization Error - content: - application/json: - schema: - "$ref": "#/components/schemas/ObjectServiceResponse" - examples: - sampleTransportationOrderErrorResponse: - value: - errors: - - code: '401' - message: Unauthorized - source: - isCompleted: true - isFaulted: true - result: - '500': - description: Server Error - content: - application/json: - schema: - "$ref": "#/components/schemas/ObjectServiceResponse" - examples: - sampleTransportationOrderErrorResponse: - value: - errors: - - code: '500' - message: Unexpected server error has occurred. Please try again after some time. - source: - isCompleted: true - isFaulted: true - result: -components: - schemas: - ActivityInformation: - type: object - description: Use this to provide info about activities and milestones updates for the shipment. - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2023-07-09T11:07:38.446' - gmtOffset: - minLength: 1 - maxLength: 20 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - activityID: - description: Unique identifier for the activity - minLength: 1 - maxLength: 128 - type: [string, "null"] - example: Delivered - activityLocation: - description: Location details of the activity - "$ref": "#/components/schemas/ActivityLocation" - activitySubType: - description: Optional field used to specify additional details for the activity - minLength: 1 - maxLength: 250 - type: [string, "null"] - example: OnTime - activitySubTypeDescription: - description: Field used to specify additional details for the activity sub type - minLength: 1 - maxLength: 250 - type: [string, "null"] - deliveryInformation: - description: This field is used to capture any details about package delivery - "$ref": "#/components/schemas/DeliveryInformation" - description: - minLength: 1 - maxLength: 250 - type: string - description: activity description - example: Package delivered to consignee - localDateTime: - minLength: 1 - maxLength: 100 - type: string - format: date-time - sensorEvent: - description: Use this flag to specify if this activity is a result of sensor event - type: [boolean, "null"] - type: - description: This field is used to specify the type of activity or event - minLength: 1 - maxLength: 25 - type: string - additionalProperties: true - ActivityLocation: - type: object - properties: - city: - description: City name where the activity generated - minLength: 1 - maxLength: 512 - type: string - example: Atlanta - country: - description: Country name where the activity generated - minLength: 1 - maxLength: 512 - type: string - example: United States Of America - latitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Latitude - example: "+29.749907" - longitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Longitude - example: "-95.358421" - postalCode: - minLength: 1 - maxLength: 25 - type: [string, "null"] - stateProvince: - minLength: 1 - maxLength: 512 - type: [string, "null"] - example: "GA" - additionalProperties: false - BillingInformation: - type: object - description: Use this field to specify whom the shipment is charged to and descriptions for billing code - properties: - billingTermCode: - description: Use this field to specify whom the shipment is charged to (consignee, shipper, third party) - minLength: 1 - maxLength: 10 - type: [string, "null"] - example: ThirdParty - billingTermDescription: - description: Descriptions for billing code - minLength: 1 - maxLength: 1000 - type: [string, "null"] - example: Paid by third party - additionalProperties: false - Carrier: - type: object - description: Use this field to provide info about carrier used for shipment - properties: - carrierCode: - description: Carrier code of carrier used for shipment - minLength: 1 - maxLength: 50 - type: [string, "null"] - example: UGFF - carrierName: - minLength: 1 - maxLength: 255 - type: [string, "null"] - carrierType: - description: Carrier type of carrier used for shipment - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Freight - additionalProperties: false - DeliveryInformation: - type: object - description: This field is used to capture any details about package delivery - properties: - actualDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2023-07-09T11:07:38.446' - actualDeliveryDateTimegmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: actual delivery datetime gmt offset - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - podSignatureImage: - minLength: 1 - type: [string, "null"] - format: base64encodedstring - podSignatureText: - minLength: 1 - type: [string, "null"] - podSignedBy: - minLength: 1 - maxLength: 500 - type: [string, "null"] - example: "John" - podSignedOn: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - additionalProperties: false - Error: - type: object - properties: - code: - minLength: 1 - maxLength: 500 - type: [string, "null"] - message: - minLength: 1 - maxLength: 500 - type: [string, "null"] - source: - description: Source method name from where the exception is generated - minLength: 1 - maxLength: 500 - type: [string, "null"] - additionalProperties: false - ExceptionInformation: - type: object - description: This is used to provide additional details about the package delivery exception - properties: - exceptionType: - description: This field is used to provide type of exception - minLength: 1 - maxLength: 255 - type: string - example: Damaged - reasonCode: - description: This field is used to provide reason code of exception - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Weather - reasonDescription: - description: This field is used to provide reason description of exception - minLength: 1 - maxLength: 2000 - type: [string, "null"] - example: Hot weather - resolutionCode: - description: This field is used to provide resolution code of exception - minLength: 1 - maxLength: 255 - type: string - example: Freezer - resolutionDescription: - description: This field is used to provide resolution description of exception - minLength: 1 - maxLength: 2000 - type: [string, "null"] - example: Freezer will be used for vaccines - statusCode: - description: This field is used to provide status code of exception - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Controllable - statusDescription: - description: This field is used to provide status description of exception - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Controllable - exceptionCreatedDate: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - exceptionCreatedDateGmt: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - exceptionCreatedDateGmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - additionalProperties: false - Gps: - type: object - description: Use this field for shipment tracking - properties: - city: - description: City name where the shipment is currently present - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: Atlanta - country: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Country name where the shipment is currently present - example: United States Of America - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - latitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Latitude - example: "+29.749907" - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - longitude: - minLength: 1 - maxLength: 20 - type: [string, "null"] - description: Longitude - example: "-95.358421" - additionalProperties: false - HumidityLevel: - type: object - description: Use this field to provide information about the shipment humidity conditions - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - humidity: - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "40" - humidityUOM: - description: Humidity Unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: g/m3 - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - additionalProperties: false - InternationalShipment: - description: Use this field for international shipment info like country and commodity code - type: object - properties: - harmonizedCommodityCode: - description: The international commodity or harmonized code that represents the commodity contained in the invoice line - minLength: 1 - maxLength: 50 - type: [string, "null"] - example: "0701.10" - shipmentExportCountryCode: - description: Country Code of shipment export - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: US - specialInstructions: - description: Any international special instructions required - minLength: 1 - type: [string, "null"] - additionalProperties: false - LightStrength: - description: Light sensor data - type: object - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - light: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Light sensor - example: "20" - lightUOM: - minLength: 1 - maxLength: 25 - type: [string, "null"] - enum: - - lux - - candles - - lumens - - footcandles - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - additionalProperties: false - ObjectServiceResponse: - description: Service response object containgin details if the shipments were processed successfully or not. - type: object - properties: - errors: - type: [array, "null"] - items: - "$ref": "#/components/schemas/Error" - isCompleted: - description: This field denotes if the request was processed successfully or not - type: boolean - isFaulted: - description: This field denotes if there is any error while precessing the shipments - type: boolean - result: - description: List of shipments received in request with the status if they were processed successfully or not - type: [object, "null"] - additionalProperties: false - OrderDetails: - required: - - customerAccountNumber - - shipmentDetails - type: object - description: Use this section to provide/map info about the order (ex load, shipment etc) - properties: - customerAccountNumber: - minLength: 1 - maxLength: 100 - type: string - pattern: ^[a-zA-Z0-9_]*$ - orderNumber: - minLength: 1 - maxLength: 100 - type: [string, "null"] - customerPONumber: - minLength: 1 - type: [string, "null"] - description: Customer Purchase Order Number - example: "SO1023674" - orderPlacedDate: - minLength: 1 - maxLength: 100 - type: string - format: date-time - example: '2023-07-09T11:07:38.446' - shipmentDetails: - type: array - description: Use this section to provide information about the shipment - maxItems: 500 - items: - "$ref": "#/components/schemas/ShipmentDetail" - additionalProperties: false - PartyDetail: - description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc. - type: object - properties: - city: - minLength: 1 - maxLength: 512 - type: string - description: Party(Shipper, Consignee, etc) city name - example: Atlanta - countryCode: - minLength: 1 - maxLength: 50 - type: string - description: Party(Shipper, Consignee, etc) Country code - example: US - stateCode: - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "GA" - type: - minLength: 1 - maxLength: 10 - type: string - enum: - - Shipper - - Consignee - additionalProperties: false - SC360Interface: - description: Supply chain 360 interface - required: - - docType - - orderDetails - - sourceSystem - type: object - properties: - sbMessageId: - description: Service Bus message id - minLength: 1 - type: [string, "null"] - example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" - docFlow: - minLength: 1 - maxLength: 25 - type: string - description: Field for publishers to populate about the document flow type - enum: - - Inbound - - Outbound - docId: - minLength: 16 - maxLength: 50 - type: string - description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. - docTime: - minLength: 1 - maxLength: 100 - type: string - description: Current Date/Time when message is generated in UTC format - format: date-time - docType: - minLength: 1 - maxLength: 25 - type: string - enum: - - OrderStatus - - Order - docVer: - minLength: 1 - maxLength: 10 - type: string - description: Document version. Current version is 1.0 - transactionType: - minLength: 1 - type: [string, "null"] - orderDetails: - type: array - maxItems: 500 - items: - "$ref": "#/components/schemas/OrderDetails" - originalDocId: - minLength: 1 - maxLength: 50 - type: [string, "null"] - description: Unique Identifier for JSON message at the publisher side. Optional field for message publishers to populate - sourceSystem: - minLength: 1 - maxLength: 50 - type: string - description: source system name - example: "BOMI" - partnerId: - minLength: 1 - type: [string, "null"] - additionalProperties: false - SC360InterfaceSC360IngestRequest: - description: Supply chain 360 interface ingest request - required: - - apiVersion - - request - type: object - properties: - request: - "$ref": "#/components/schemas/SC360Interface" - apiVersion: - minLength: 1 - type: string - enum: - - v1.0 - additionalProperties: false - SC360Response: - description: Supply chain 360 response - required: - - docId - - docType - - messageId - - orderNumber - - shipmentNumber - - shipmentUniquekey - type: object - properties: - messageId: - description: Service bus message id for a shipment - minLength: 1 - type: string - example: "6e01c1d5-3ee4-49ad-bc3a-b6b787670f71" - orderNumber: - description: Unique identifier for the order/load. An order could have multiple shipments. - minLength: 1 - type: string - example: LD123437 - shipmentNumber: - minLength: 1 - type: string - description: Unique identifier of a shipment - example: SN12345678 - shipmentUniquekey: - minLength: 1 - type: string - description: shipmentUniqueKey is used to uniquely identify a shipment - example: BOMI_SN1658566_20230709 - docId: - minLength: 1 - type: string - description: Unique Identifier for JSON message. Source system will generate a value for this field and ensure it is unique. - example: ccf2f1d1-82f5-4cf5-8a73-6c9417341cdb - docType: - minLength: 1 - type: string - enum: - - OrderStatus - - Order - isCompleted: - type: boolean - additionalProperties: false - SC360ResponseListServiceResponse: - description: Supply chain 360 response list of process shipments - type: object - properties: - errors: - type: [array, "null"] - items: - "$ref": "#/components/schemas/Error" - isCompleted: - description: This field denotes if the request was processed successfully or not - type: boolean - isFaulted: - description: This field denotes if there is any error while precessing the shipments - type: boolean - result: - description: List of shipments received in request with the status if they were processed successfully or not - type: [array, "null"] - items: - "$ref": "#/components/schemas/SC360Response" - additionalProperties: false - SensorData: - type: object - description: This section is used for capturing sensor level data for the package when the sensor event flag is true - properties: - gps: - "$ref": "#/components/schemas/Gps" - humidityLevel: - "$ref": "#/components/schemas/HumidityLevel" - lightStrength: - "$ref": "#/components/schemas/LightStrength" - shockForce: - "$ref": "#/components/schemas/ShockForce" - temperature: - "$ref": "#/components/schemas/Temperature" - additionalProperties: false - Service: - type: object - description: Service information like service code (ex ground, overnight, international and descriptions) - properties: - carrierServiceCode: - description: Use this field to specify the carrier service level if different than service level - minLength: 1 - maxLength: 255 - type: string - example: Standard - carrierServiceDescription: - description: Description for carrier service level - minLength: 1 - type: [string, "null"] - example: Standard - handlingCode: - description: Shipment package handling instructions code - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: Fragile - handlingDescription: - description: Shipment package handling instructions description - minLength: 1 - type: [string, "null"] - example: Fragile content, handle with care - saturdayDeliveryFlag: - minLength: 1 - maxLength: 1 - type: [string, "null"] - enum: - - Y - - N - serviceCode: - description: Code of service level for the shipment - minLength: 1 - maxLength: 255 - type: [string, "null"] - example: GND - serviceDescription: - description: Description for the level of service - minLength: 1 - type: [string, "null"] - example: Ground - additionalProperties: false - ShipUnit: - description: List of shipping units like items, length, width, height, etc - type: object - properties: - dimensionWeight: - description: Shipment Unit Dimensional Weight. This is the estimated weight of the package based on its dimensions. - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "200.00" - dimensionWeightUOM: - description: Dimensional weight unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: kg/dm3 - height: - description: Height of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "25.10" - heightUOM: - description: Height unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: cm - itemDesciption: - description: Shipment unit items description - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: medical equipments - length: - description: Length of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "25.10" - lengthUOM: - description: Length unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: cm - weight: - description: Weight of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "20" - weightUOM: - description: Weight unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: kg - width: - description: Widht of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "25.10" - widthUOM: - description: Width unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: cm - shipmentQuantity: - description: Quantity of items in shipment unit - type: [integer, "null"] - format: int32 - example: 20 - volume: - description: Volume of the shipment package unit - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: "50.0" - volumeUOM: - description: Volume unit of measurement - minLength: 1 - maxLength: 25 - type: [string, "null"] - example: dm3 - additionalProperties: false - ShipmentDetail: - required: - - shipmentNumber - - shipmentPlacedDate - - shipmentUniqueKey - type: object - properties: - activityInformation: - description: Use this to provide info about activities and milestones updates for the shipment. - "$ref": "#/components/schemas/ActivityInformation" - actualPickupDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - billingInformation: - description: Use this field to specify whom the shipment is charged to and descriptions for billing code - "$ref": "#/components/schemas/BillingInformation" - carrier: - description: Use this field to provide info about carrier used for shipment - "$ref": "#/components/schemas/Carrier" - collectOnDeliveryAmount: - minLength: 1 - maxLength: 225 - type: [string, "null"] - collectOnDeliveryCurrency: - minLength: 1 - maxLength: 200 - type: [string, "null"] - description: Currency code of the amount received on delivery - earliestDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - internationalShipment: - "$ref": "#/components/schemas/InternationalShipment" - latestDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - example: '2019-08-24T14:15:22Z' - leadShipmentNumber: - minLength: 1 - maxLength: 100 - type: [string, "null"] - description: Use this field to provide key information for the lead shipment in case there are multiple packages in a shipment - partyDetails: - type: [array, "null"] - description: Use this section to provide info about entities associated with the shipment. For ex, Shipper, Consignee etc - items: - "$ref": "#/components/schemas/PartyDetail" - rescheduledDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - scheduledDeliveryDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - scheduledPickupDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - sensorData: - description: This section is used for capturing sensor level data for the package - "$ref": "#/components/schemas/SensorData" - service: - "$ref": "#/components/schemas/Service" - shipUnits: - type: [array, "null"] - description: List of shipping units like number of items, length, width, height, - items: - "$ref": "#/components/schemas/ShipUnit" - shipmentDescription: - minLength: 1 - maxLength: 1000 - type: [string, "null"] - description: Shipment contents description text - example: fragile material - shipmentNumber: - minLength: 1 - maxLength: 100 - type: string - description: Unique identifier of a shipment - example: SN12345678 - shipmentReferences: - type: [array, "null"] - description: List of reference information about the package - items: - "$ref": "#/components/schemas/ShipmentReference" - specialInformation: - description: Provide any special information about shipment like Hazardous material - "$ref": "#/components/schemas/SpecialInformation" - temperatureCondition: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Temperature condition - example: "Amber" - shipmentPlacedDate: - type: string - format: date-time - carrierShipmentNumber: - type: [array, "null"] - items: - type: string - shipmentUniqueKey: - minLength: 1 - maxLength: 100 - type: string - description: shipmentUniqueKey is used to uniquely identify a shipment - shipmentBookedDate: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - exceptionInformation: - description: This is used to provide additional details about the package delivery exception - "$ref": "#/components/schemas/ExceptionInformation" - additionalProperties: false - ShipmentReference: - type: object - description: List of reference information about the package - properties: - referenceCode: - minLength: 1 - maxLength: 50 - type: [string, "null"] - description: Code that identifies the reference value - example: Order - referenceType: - minLength: 1 - maxLength: 50 - type: string - description: This field is used to specify the type of reference field - example: shipment - referenceValue: - minLength: 1 - maxLength: 255 - type: string - description: Reference value - example: PO12345 - additionalProperties: false - ShockForce: - type: object - description: Has shipment been dropped or otherwise exposed to an impact force that exceeds a predetermined level - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - shock: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Shipment has been dropped or otherwise exposed to an impact force that exceeds a predetermined level - example: "20" - shockUOM: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Shock Unit of measurement - example: "g's" - additionalProperties: false - SpecialInformation: - type: object - description: Provide any special information about shipment like Hazardous material - properties: - hazmatCategoryCode: - minLength: 1 - maxLength: 255 - type: [string, "null"] - description: Hazardous material category code - example: Explosives - hazmatCategoryDescription: - minLength: 1 - maxLength: 1000 - type: [string, "null"] - description: Hazardous material category description - example: Explosives - hazmatFlag: - minLength: 1 - maxLength: 1 - type: [string, "null"] - enum: - - Y - - N - additionalProperties: false - Temperature: - type: object - description: Temperature information of the shipment - properties: - gmtDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - gmtOffset: - minLength: 1 - maxLength: 25 - type: [string, "null"] - pattern: '[+-][0-9]{2}:[0-9]{2}\b' - example: "-04:00" - localDateTime: - minLength: 1 - maxLength: 100 - type: [string, "null"] - format: date-time - temperatureInfo: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Temperature value of the container - example: "10" - temperatureUOM: - minLength: 1 - maxLength: 25 - type: [string, "null"] - description: Temperature unit of measurement - example: "C" - enum: - - C - - F - additionalProperties: false - securitySchemes: - OAuth2ClientCredentialsWithAssertion: - type: oauth2 - description: | - This API uses OAuth 2.0 with mutual TLS for client authentication. - The client must include a client assertion signed with a certificate in the token request to token endpoint - client_assertion_type: urn:ietf:params:oauth:client-assertion-type:jwt-bearer - flows: - clientCredentials: - tokenUrl: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token - scopes: {} -security: -- OAuth2ClientCredentialsWithAssertion: [] - From c4ca70c103466f66b397a2f7faeb6541bd3c671f Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 10 Feb 2026 09:03:07 -0500 Subject: [PATCH 69/89] Update --- Shipping.yaml | 321 ++++++++++++-------------------------------------- 1 file changed, 77 insertions(+), 244 deletions(-) diff --git a/Shipping.yaml b/Shipping.yaml index 4dba814..a61e4a4 100644 --- a/Shipping.yaml +++ b/Shipping.yaml @@ -313,7 +313,7 @@ paths: ShipmentServiceOptions: InternationalForms: FormType: '04' - FormGroupIdName: USMCA Form + FormGroupIdName: NAFTA Form Contacts: SoldTo: Option: " " @@ -2863,7 +2863,7 @@ paths: ShipmentServiceOptions: InternationalForms: FormType: '04' - FormGroupIdName: USMCA Form + FormGroupIdName: NAFTA Form Contacts: SoldTo: Option: " " @@ -4975,22 +4975,6 @@ components: type: string minLength: 2 maxLength: 2 - ShipperType: - description: |- - Shipment Value for ShipperType. 01 = Business 02 = Consumer/Individual NA = Not Applicable - Required for EU Inbound Shipments - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - ConsigneeType: - description: |- - Shipment Value for ConsigneeType. 01 = Business 02 = Consumer/Individual NA = Not Applicable - Required for EU Inbound Shipments - maximum: 1 - type: string - minLength: 2 - maxLength: 2 MasterCartonID: description: 'Master Carton ID. If Economy Service (17 or 72) : Economy Shipment will be associated with given Master Carton ID. If Non-Economy @@ -5141,8 +5125,7 @@ components: minLength: 1 maxLength: 14 EMailAddress: - description: Shipper's email address. Must be associated with the UserId - specified in the AccessRequest XML. + description: Shipper's email address. maximum: 1 type: string minLength: 1 @@ -5684,7 +5667,7 @@ components: - 1051 = Singapore GST Registration Number - 1052 = ARN Registration Number - 1053 = IRD Registration Number - - 1054 = Malaysia Low Value Goods Sales Tax Registration Number + - 1054 = Malaysia Low Value Goods Sales Tax Registration Vendor Collect ID Number type code will be printed on commercial invoice if present. maximum: 1 @@ -5806,13 +5789,13 @@ components: type: string minLength: 2 maxLength: 2 - xml: - name: BillShipper + xml: + name: BillShipper description: Container for the BillShipper billing option. The three payment methods that are available for the Bill Shipper billing option are alternate payment method, account number or credit card. This element or its sibling element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator, must be - present but no more than one can be present. + present but no more than one can be present. BillShipper_CreditCard: type: object maximum: 1 @@ -6475,7 +6458,8 @@ components: - 83 = UPS Today Dedicated Courier - 84 = UPS Today Intercity - 85 = UPS Today Express - - 86 = UPS Today Express Saver + - 86 = UPS Today Express Saver + - 93 = Ground Saver - 96 = UPS Worldwide Express Freight. - C6 = Roadie XD AM (Morning delivery) - C7 = Roadie XD PM (Afternoon delivery) @@ -6966,7 +6950,7 @@ components: Valid values: - 01 - Invoice - 03 - CO - - 04 - USMCA + - 04 - NAFTA CO - 05 - Partial Invoice - 06 - Packinglist - 07 - Customer Generated Forms @@ -6992,9 +6976,9 @@ components: "$ref": "#/components/schemas/InternationalForms_CN22Form" AdditionalDocumentIndicator: description: "Presence of the indicator means user will supply additional - document, such as EEI, USMCA or CO. This indicator should be set when + document, such as EEI, NAFTA_CO or CO. This indicator should be set when the shipper intends to utilize UPS paperless invoice functionality AND - the shipper has SELF-PREPARED other International Forms (EEI, CO, USMCA) + the shipper has SELF-PREPARED other International Forms (EEI, CO, NAFTACO) to accompany the shipment. \nIt is evaluated only when: \n1. Account is paperless enabled. \n2. Movement requires an invoice.\n3. Destination country or territory accepts paperless invoice. \n4. Invoice data is supplied @@ -7076,7 +7060,7 @@ components: used by Customs. Examples of declarations that might be entered in this field are: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff treatment under - the USMCA. I hereby certify that the information on this invoice is true + the NAFTA. I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above. EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA @@ -7232,7 +7216,7 @@ components: type: string OverridePaperlessIndicator: description: The application will automatically provide a copy of the invoice - or USMCA with each response regardless of whether the user has enabled + or NAFTA/CO with each response regardless of whether the user has enabled Paperless account. The user now has the option to print or ignore the copy provided. maximum: 1 @@ -7251,8 +7235,7 @@ components: type: string xml: name: InternationalForms - description: International Forms information. This is applicable to Trade Direct SMALLPACKAGE International Child - movements and not applicable to Trade Direct Master or Trade Direct LTL Child movements. + description: International Forms information. InternationalForms_UserCreatedForm: type: object maximum: 13 @@ -7446,21 +7429,11 @@ components: type: string minLength: 40 maxLength: 40 - DDSReferenceNumber: - "$ref": "#/components/schemas/CN22Content_CN22DDSReferenceNumber" xml: name: CN22Content description: "Container for CN22 content. Required if the CN22 form container is present. \nNote: The maximum number of goods printed on the CN22 form when a combined MI package and CN22 form label is requested is 30." - CN22Content_CN22DDSReferenceNumber: - type: object - maximum: 1 - properties: - Number: - description: holds a list of DDS Reference Numbers - maximum: 5 - type: string CN22Content_CN22ContentWeight: type: object required: @@ -7636,9 +7609,9 @@ components: xml: name: Contacts description: Holds the contact information of various parties. Applicable for - EEI and USMCA only. Required for USMCA and EEI. Ultimate consignee contact + EEI and NAFTA CO only. Required for NAFTA CO and EEI. Ultimate consignee contact information is required for EEI. Producer contact information is required - for USMCA + for NAFTA CO maximum: 1 Contacts_ForwardAgent: type: object @@ -7900,7 +7873,7 @@ components: list of additional producers, including the legal name, address (including country or territory), and legal tax identification number, cross-referenced to the goods described in the Description of Goods field. Applies to - USMCA. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02 + NAFTA CO. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02 - SAME AS EXPORTER\n03 - ATTACHED LIST\n04 - UNKNOWN" maximum: 1 type: string @@ -7908,14 +7881,14 @@ components: maxLength: 2 CompanyName: description: 'Company Name or the Individual name of the Producer. Applies - to USMCA. Only applicable when producer option is empty or not present. - Conditionally required for: USMCA, when Producer option is not specified.' + to NAFTA CO. Only applicable when producer option is empty or not present. + Conditionally required for: NAFTA CO, when Producer option is not specified.' maximum: 1 type: string minLength: 1 maxLength: 35 TaxIdentificationNumber: - description: Tax ID of the Producer. Applies to USMCA. Only applicable + description: Tax ID of the Producer. Applies to NAFTA CO. Only applicable when producer option is empty or not present maximum: 1 type: string @@ -7924,7 +7897,7 @@ components: Address: "$ref": "#/components/schemas/Producer_Address" AttentionName: - description: Contact name at the Producer location. Applies to USMCA. + description: Contact name at the Producer location. Applies to NAFTA CO. maximum: 1 type: string minLength: 1 @@ -7932,18 +7905,18 @@ components: Phone: "$ref": "#/components/schemas/Producer_Phone" EMailAddress: - description: Producer email address. Applies to USMCA. + description: Producer email address. Applies to NAFTA CO. maximum: 1 type: string minLength: 1 maxLength: 50 xml: name: Producer - description: "Information of the producer. The USMCA Certificate of Origin must + description: "Information of the producer. The NAFTA Certificate of Origin must be completed, signed, and dated by the exporter. \nWhen the Certificate is completed by the producer for use by the exporter, it must be completed, signed, and dated by the producer. The date must be the date the Certificate was completed - and signed. Applies to USMCA. Required for USMCA forms." + and signed. Applies to NAFTA CO. Required for NAFTA CO forms." Producer_Address: type: object maximum: 1 @@ -7961,13 +7934,13 @@ components: minLength: 1 maxLength: 35 City: - description: "City of the Producer. Applies to USMCA. Conditionally required for: USMCA, when Producer option is not specified." + description: "City of the Producer. Applies to NAFTA CO. Conditionally required for: NAFTA CO, when Producer option is not specified." maximum: 1 type: string minLength: 1 maxLength: 30 StateProvinceCode: - description: State of the Producer. Applies to USMCA. Required for certain countries or territories. + description: State of the Producer. Applies to NAFTA CO. Required for certain countries or territories. maximum: 1 type: string minLength: 1 @@ -7979,22 +7952,22 @@ components: minLength: 1 maxLength: 30 PostalCode: - description: Postal code of the Producer. Applies to USMCA. Required for certain countries or territories. The length of the postal code depends on the country or territory code. + description: Postal code of the Producer. Applies to NAFTA CO. Required for certain countries or territories. The length of the postal code depends on the country or territory code. maximum: 1 type: string minLength: 1 maxLength: 9 CountryCode: - description: Country or Territory code of the Producer. Applies to USMCA. + description: Country or Territory code of the Producer. Applies to NAFTA CO. maximum: 1 type: string minLength: 2 maxLength: 2 xml: name: Address - description: 'Address information of the Producer. Applies to USMCA. Only + description: 'Address information of the Producer. Applies to NAFTA CO. Only applicable if producer option is empty or not present. Conditionally required - for: USMCA, when Producer option is not specified.' + for: NAFTA CO, when Producer option is not specified.' Producer_Phone: type: object maximum: 1 @@ -8002,20 +7975,20 @@ components: - Number properties: Number: - description: The locations phone number of the Producer. Applies to USMCA. + description: The locations phone number of the Producer. Applies to NAFTA CO. maximum: 1 type: string minLength: 1 maxLength: 15 Extension: - description: The locations phone extension of the Producer. Applies to USMCA. + description: The locations phone extension of the Producer. Applies to NAFTA CO. maximum: 1 type: string minLength: 1 maxLength: 4 xml: name: Phone - description: Phone number information of Producer. Applies to USMCA. + description: Phone number information of Producer. Applies to NAFTA CO. Contacts_SoldTo: type: object maximum: 1 @@ -8046,7 +8019,7 @@ components: Phone: "$ref": "#/components/schemas/SoldTo_Phone" Option: - description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02." + description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02." maximum: 1 type: string minLength: 2 @@ -8069,8 +8042,8 @@ components: name: SoldTo description: SoldTo Container. The Sold To party's country code must be the same as the Ship To party's country code with the exception of Canada and - satellite countries. Applies to Invoice and USMCA Forms. Required if Invoice - or USMCA (International Form) is requested. + satellite countries. Applies to Invoice and NAFTA CO Forms. Required if Invoice + or NAFTA CO (International Form) is requested. SoldTo_Phone: type: object maximum: 1 @@ -8101,7 +8074,7 @@ components: - CountryCode properties: AddressLine: - description: SoldTo location's street address. Applies to USMCA. + description: SoldTo location's street address. Applies to NAFTA CO. maximum: 3 type: array items: @@ -8140,7 +8113,7 @@ components: maxLength: 2 xml: name: Address - description: Sold To Address Container. Applies to USMCA. + description: Sold To Address Container. Applies to NAFTA CO. InternationalForms_Product: type: object maximum: 1 @@ -8162,8 +8135,8 @@ components: CommodityCode: description: '6-to-15-alphanumeric commodity code. Customs uses this code to determine what duties should be assessed on the commodity. Applies - to Invoice, Partial Invoice and USMCA. Required for USMCA and optional - for Partial Invoice. Should be at least 6 alphanumeric. For USMCA: + to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional + for Partial Invoice. Should be at least 6 alphanumeric. For NAFTA CO: For each good described in Description of Goods field, identify the H.S. tariff classification to six digits. If the good is subject to a specific rule of origin in Annex 401 that requires eight digits, identify to eight @@ -8194,13 +8167,13 @@ components: maxLength: 2 JointProductionIndicator: description: If present, JNT will be used as the origin of country or territory - code on the USMCA form and the Product/Origincountry or territoryCode - tag will be ignored. Applies to USMCA only. + code on the NAFTA form and the Product/Origincountry or territoryCode + tag will be ignored. Applies to NAFTA CO only. maximum: 1 type: string NetCostCode: description: | - For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values: + For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to NAFTA CO only. Required for NAFTA CO. Valid values: - NC - ND - NO @@ -8216,7 +8189,7 @@ components: are contained in Chapter Four and Annex 401. \n\nAdditional rules are described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix 6 (certain textile goods) and Annex 308.1 (certain automatic data processing - goods and their parts). Applies to USMCA only." + goods and their parts). Applies to NAFTA CO only." maximum: 1 type: string minLength: 1 @@ -8228,7 +8201,7 @@ components: an originating good. \nNo [2] - Reliance on the producers written representation (other than a Certificate of Origin) that the good qualifies as an originating good. \nNo [3] - A completed and signed Certificate for the good voluntarily - provided to the exporter by the producer. Applicable for USMCA and + provided to the exporter by the producer. Applicable for NAFTA CO and is required. Valid values: Yes, No [1], No [2], and No [3]." maximum: 1 type: string @@ -8294,15 +8267,13 @@ components: "$ref": "#/components/schemas/Product_PackingListInfo" EEIInformation: "$ref": "#/components/schemas/Product_EEIInformation" - DDSReferenceNumber: - "$ref": "#/components/schemas/Product_DDSReferenceNumber" xml: name: Product description: "Contains the commodity/product information. Applies to EEI, Invoice, - Partial Invoice, CO and USMCA. When any International form is requested, + Partial Invoice, CO and NAFTA CO. When any International form is requested, at least one Product must be present. \n\nMaximum number of products allowed for different forms are:\n\n50: Package Packing List\n\n100: Commercial Invoice, - USMCA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice + NAFTA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice this container is optional." Product_Unit: type: object @@ -8377,7 +8348,7 @@ components: BeginDate: description: 'If the RVC is calculated over a period of time, it should be identified by the begin date (yyyyMMdd) of that period. (Reference: - Articles 402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.' + Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.' maximum: 1 type: string minLength: 8 @@ -8385,14 +8356,14 @@ components: EndDate: description: 'If the RVC is calculated over a period of time, it should be identified by the End date (yyyyMMdd) of that period. (Reference: Articles - 402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.' + 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.' maximum: 1 type: string minLength: 8 maxLength: 8 xml: name: NetCostDateRange - description: Date Range for regional value content (RVC). Applies to USMCA + description: Date Range for regional value content (RVC). Applies to NAFTA CO only. Product_ProductWeight: type: object @@ -8509,7 +8480,7 @@ components: - FormType properties: FormType: - description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – USMCA. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED. + description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – NAFTA CO. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED. type: array items: type: string @@ -8562,14 +8533,6 @@ components: description: |- Data Container holding package/product related information that will break up the product into each package on the packing list. Total product amount must equal the product unit value above. Required for packaging list and Air Freight Packing list. Packaging list max allowed : 20 Air Freight Packaging list max allowed: 200 - Product_DDSReferenceNumber: - type: object - maximum: 1 - properties: - Number: - description: holds a list of DDS Reference Numbers - maximum: 5 - type: string Product_EEIInformation: type: object maximum: 1 @@ -8811,7 +8774,7 @@ components: description: Begin date of the blanket period. It is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). Applies - to USMCA form only. Required for USMCA. Format is yyyyMMdd. This + to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This is not valid for a paperless shipment. maximum: 1 type: string @@ -8819,7 +8782,7 @@ components: maxLength: 8 EndDate: description: End Date of the blanket period. It is the date upon which the - blanket period expires. Applies to USMCA form only. Required for USMCA + blanket period expires. Applies to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This is not valid for a paperless shipment. maximum: 1 type: string @@ -8827,12 +8790,12 @@ components: maxLength: 8 xml: name: BlanketPeriod - description: This field should be entered if the USMCA Certificate covers multiple + description: This field should be entered if the NAFTA Certificate covers multiple shipments of identical goods as described in the Description of Goods field - that are imported into a USMCA country or territory for a specified period + that are imported into a NAFTA country or territory for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between - these dates. Applies to USMCA form only. Required for USMCA. This + these dates. Applies to NAFTA CO form only. Required for NAFTA CO. This is not valid for a paperless shipment. ShipmentServiceOptions_DeliveryConfirmation: type: object @@ -9143,8 +9106,8 @@ components: name: Package required: - Packaging - description: Package Information container. For Return Shipments up to - 20 packages are allowed. US/PR origin return movements are limited + description: Package Information container. For Return Shipments up to and + including 20 packages are allowed. US/PR origin return movements are limited to only one package. For Mail Innovations and Simple Rate shipments only one package is allowed. Shipment_TradeDirect: @@ -9159,7 +9122,7 @@ components: $ref: '#/components/schemas/TradeDirect_Child' GeneralDescriptionOfGoods: description: General description of the goods being shipped. It is required for master shipment. - pattern: ^(?!\s*$)[a-zA-Z0-9 ]+$ + pattern: ^[a-zA-Z0-9 ]{1,100}$ type: string ShipmentType: description: | @@ -9179,7 +9142,7 @@ components: CurrencyCode: description: The currency code for the shipment as per ISO 4217. type: string - pattern: ^(?!\s*$)[A-Z]{3}$ + pattern: ^[A-Z]{3}$ xml: name: TradeDirect maximum: 1 @@ -9232,14 +9195,12 @@ components: type: string minLength: 1 maxLength: 35 - pattern: ^(?!\s*$).{1,35}$ AttentionName: description: Master Sold to Contact Name. maximum: 1 type: string minLength: 1 maxLength: 35 - pattern: ^.{0,35}$ TaxIdentificationNumber: deprecated: true description: Master Sold To Tax Identification Number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container. @@ -9250,7 +9211,7 @@ components: Phone: $ref: '#/components/schemas/TradeDirect_Phone' Option: - description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02." + description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02." maximum: 1 type: string minLength: 2 @@ -9286,14 +9247,12 @@ components: type: string minLength: 1 maxLength: 35 - pattern: ^(?!\s*$).{1,35}$ AttentionName: description: Master Pickup Contact Name. maximum: 1 type: string minLength: 1 maxLength: 35 - pattern: ^.{0,35}$ Phone: $ref: '#/components/schemas/TradeDirect_Phone' Address: @@ -9337,12 +9296,12 @@ components: description: Primary address line includes street number and street name (when applicable). maximum: 3 type: string - pattern: ^(?!\s*$).{1,35}$ + pattern: ^[A-Za-z0-9\s.,#/-]{1,35}$ example: 123 South Main St City: description: The name of the city for the address. type: string - pattern: ^(?!\s*$).{1,35}$ + pattern: ^[a-zA-Z\s.,]{1,35}$ example: Atlanta StateProvinceCode: description: The code for the state or province for the address. @@ -9401,15 +9360,15 @@ components: maxLength: 150 DeclarationStatement: description: | - The type of declaration statement. Can be invoice or USMCA. + The type of declaration statement. Can be invoice or NAFTA. Valid values: - Invoice = Invoice declaration - - USMCA = USMCA declaration + - NAFTA = NAFTA declaration type: string - enum: ["Invoice", "USMCA"] + enum: ["Invoice", "NAFTA"] xml: name: TradeComplianceDetails description: 'Contains trade compliance details for the master shipment, such as invoice terms, export reasons, and declaration statements. It also includes additional comments or instructions for customs clearance.' @@ -9438,11 +9397,10 @@ components: Valid values: - LTL - - SMALLPACKAGE - - MI + - SMALLPACKAGE type: string - enum: ["LTL", "SMALLPACKAGE", "MI"] + enum: ["LTL", "SMALLPACKAGE"] Product: $ref: '#/components/schemas/Child_Product' LtlPackage: @@ -9466,7 +9424,7 @@ components: Description: description: Description of the product being shipped. type: string - pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,100}$ + pattern: ^[a-zA-Z0-9 ]{1,100}$ example: ALPHA BRAIN INSTANT PEACH UnitPrice: description: Price per unit of the product being shipped. @@ -9482,7 +9440,7 @@ components: description: Product number of the product being shipped. type: string example: IDID767640 - pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,20}$ + pattern: ^[a-zA-Z0-9 ]{1,20}$ CountryOriginCode: description: Country code of the product being shipped. type: string @@ -9535,123 +9493,6 @@ components: type: string enum: [ "BA", "BE", "BG", "BH", "BOX", "BT", "LB", "LBS", "L", "M", "NMB", "PA", "BU", "CI", "CM", "CON", "CR", "CS", "CT", "CY", "DOZ", "EA", "EN", "FT", "KG", "KGS", "PAL", "PC", "PCS", "PF", "OTH", "PKG", "PR", "PRS", "RL", "SET", "SME", "SYD", "TU", "YD" ] - CommodityCode: - description: '6-to-15-alphanumeric commodity code. Customs uses this code - to determine what duties should be assessed on the commodity. Applies - to Invoice, Partial Invoice and USMCA. Required for USMCA and optional - for Partial Invoice. Should be at least 6 alphanumeric. For USMCA: - For each good described in Description of Goods field, identify the H.S. - tariff classification to six digits. If the good is subject to a specific - rule of origin in Annex 401 that requires eight digits, identify to eight - digits, using the H.S. tariff classification of the country or territory - into whose territory the good is imported.' - maximum: 1 - type: string - minLength: 6 - maxLength: 15 - JointProductionIndicator: - description: If present, JNT will be used as the origin of country or territory - code on the USMCA form and the Product/Origincountry or territoryCode - tag will be ignored. Applies to USMCA only. - maximum: 1 - type: string - NetCostCode: - description: | - For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values: - - NC - - ND - - NO - maximum: 1 - type: string - minLength: 2 - maxLength: 2 - NetCostDateRange: - "$ref": "#/components/schemas/Product_NetCostDateRange" - PreferenceCriteria: - description: "Indicates the criterion (A through F) for each good described - in the Description of Goods field if applicable. \n\nThe rules of origin - are contained in Chapter Four and Annex 401. \n\nAdditional rules are - described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix - 6 (certain textile goods) and Annex 308.1 (certain automatic data processing - goods and their parts). Applies to USMCA only." - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - ProducerInfo: - description: "Indicate the following: Yes - If shipper is the producer - of the good. If not, state 02, 03, and 04 depending on whether this certificate - was based upon: \nNo [1] - Knowledge of whether the good qualifies as - an originating good. \nNo [2] - Reliance on the producers written representation - (other than a Certificate of Origin) that the good qualifies as an originating - good. \nNo [3] - A completed and signed Certificate for the good voluntarily - provided to the exporter by the producer. Applicable for USMCA and - is required. Valid values: Yes, No [1], No [2], and No [3]." - maximum: 1 - type: string - minLength: 3 - maxLength: 5 - MarksAndNumbers: - description: Any special marks, codes, and numbers that may appear on package. Applies - to CO Only. - maximum: 1 - type: string - minLength: 1 - maxLength: 35 - NumberOfPackagesPerCommodity: - description: The total number of packages, cartons, or containers for the - commodity. Applicable for CO and is required. Should be numeric. Valid - characters are 0 -9. - maximum: 1 - type: string - minLength: 1 - maxLength: 3 - ProductWeight: - "$ref": "#/components/schemas/Product_ProductWeight" - VehicleID: - description: 'Includes the following information for used self-propelled - vehicles as defined in Customs regulations 19 CFR 192.1: The unique Vehicle - Identification Number (VIN) in the proper format. Or The Product Identification - Number (PIN) for those used self-propelled vehicles for which there are - no VINs. Or the Vehicle Title Number. Applies to EEI forms only.' - maximum: 1 - type: string - minLength: 1 - maxLength: 25 - ScheduleB: - "$ref": "#/components/schemas/Product_ScheduleB" - ExportType: - description: 'Code indicating Domestic: Exports that have been produced, - manufactured, or grown in the United States or Puerto Rico. This includes - imported merchandise which has been enhanced in value or changed from - the form in which imported by further manufacture or processing in the - United States or Puerto Rico. Foreign: Merchandise that has entered the - United States and is being exported again in the same condition as when - imported. Applies to EEI forms only. Required for EEI form. Valid values: D: - Domestic; F: Foreign.' - maximum: 1 - type: string - minLength: 1 - maxLength: 1 - SEDTotalValue: - description: | - This amount will always be USD. Applies to EEI forms only. Required for EEI form. Valid characters are 0-9 and \'.\' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including \'.\' and can hold up to 2 decimal places. - - Note: This value is calculated based on the Product/Unit/Value and /Product/Unit/Number (Number of Units * Price per Unit). If the total value is incorrect it will be replaced by the actual calculated total value. - maximum: 1 - type: string - minLength: 1 - maxLength: 15 - TaxesPaid: - description: "Invoice Commodity Level Tax Collected Code for each shipment commodity line.Taxes paid Indicator is only applicable for shipments to Singapore. [TaxesPaid = 0 - No on Report], [TaxesPaid = 1 -Yes on Report], [TaxesPaid = empty - null on Report], [If TaxesPaid is not passed in input request = null on Report]" - type: string - ExcludeFromForm: - "$ref": "#/components/schemas/Product_ExcludeFromForm" - PackingListInfo: - "$ref": "#/components/schemas/Product_PackingListInfo" - EEIInformation: - "$ref": "#/components/schemas/Product_EEIInformation" - xml: name: Product description: This variable represents the product details. It is used to provide information about the product being shipped. @@ -9872,7 +9713,7 @@ components: description: 'Description of what the other charges are for.' type: string example: Miscellaneous charge - pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,30}$ + pattern: ^[a-zA-Z0-9 ]{1,30}$ xml: name: OtherCharges description: 'Any other miscellaneous charges.' @@ -13980,16 +13821,11 @@ components: maximum: 1 properties: AgentRole: - description: 'When the value passed to the AgentRole parameter is 30, - the value passed to the IDNumberTypeCode parameter must be 1002, 1005 or 0005. - (SHIP_FROM=20, CONSIGNEE=30)' + description: '(SHIP_FROM=20, CONSIGNEE=30)' type: string TaxIdentificationNumber: - items: - $ref: >- - #/components/schemas/AgentTaxIdentificationNumber_TaxIdentificationNumber - maximum: 8 - type: array + $ref: >- + #/components/schemas/AgentTaxIdentificationNumber_TaxIdentificationNumber required: - AgentRole type: object @@ -14148,11 +13984,8 @@ components: minLength: 2 maxLength: 2 AgentTaxIdentificationNumber: - type: array - items: - $ref: >- - #/components/schemas/GlobalTaxInformation_AgentTaxIdentificationNumber - maximum: 4 + $ref: >- + #/components/schemas/GlobalTaxInformation_AgentTaxIdentificationNumber type: object xml: name: GlobalTaxInformation From 4de15454b6f8eba8e3e3c566814c9d31999875e9 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Tue, 10 Feb 2026 09:03:41 -0500 Subject: [PATCH 70/89] Update Pickup.yaml --- Pickup.yaml | 176 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 172 insertions(+), 4 deletions(-) diff --git a/Pickup.yaml b/Pickup.yaml index 4490e74..6c1855d 100644 --- a/Pickup.yaml +++ b/Pickup.yaml @@ -339,10 +339,12 @@ paths: required: true content: application/json: - schema: - "$ref": "#/components/schemas/PICKUPCreationRequestWrapper" + schema: + oneOf: + - $ref: "#/components/schemas/PICKUPCreationRequestWrapper" + - $ref: "#/components/schemas/PICKUPTriggerGWNRequestWrapper" examples: - json: + '1': summary: A sample JSON request (Standard Example) value: PickupCreationRequest: @@ -388,13 +390,82 @@ paths: PaymentMethod: '01' SpecialInstruction: 'Test ' ReferenceNumber: CreatePickupRef + '2': + summary: A sample JSON request (Smart Pickup) + value: + PickupTriggerGWNRequest: + Request: + TransactionReference: + CustomerContext: "Smart Pickup Request" + AccountNumber: "1004YY" + ServiceDateOption: "01" responses: '200': description: successful operation content: application/json: schema: - "$ref": "#/components/schemas/PICKUPCreationResponseWrapper" + oneOf: + - $ref: "#/components/schemas/PICKUPCreationResponseWrapper" + - $ref: "#/components/schemas/PICKUPTriggerGWNResponseWrapper" + examples: + '1': + summary: A sample JSON response (Standard Example) + value: + PickupCreationResponse: + Response: + ResponseStatus: + Code: "1" + Description: "Success" + Alert: + - Code: "string" + Description: "string" + TransactionReference: + CustomerContext: "string" + PRN: "stringstrin" + WeekendServiceTerritory: + SatWST: "s" + SunWST: "s" + WeekendServiceTerritoryIndicator: "s" + RateStatus: + Code: "st" + Description: "string" + RateResult: + Disclaimer: + Code: "st" + Description: "string" + RateType: "st" + CurrencyCode: "str" + ChargeDetail: + - ChargeCode: "s" + ChargeDescription: "string" + ChargeAmount: "stringst" + IncentedAmount: "stringst" + TaxAmount: "stringst" + TaxCharges: + - Type: "str" + MonetaryValue: "stringst" + TotalTax: "stringst" + GrandTotalOfAllCharge: "stringst" + GrandTotalOfAllIncentedCharge: "string" + PreTaxTotalCharge: "stringst" + PreTaxTotalIncentedCharge: "string" + '2': + summary: A sample JSON response (Smart Pickup) + value: + PickupTriggerGWNResponse: + Response: + ResponseStatus: + Code: "1" + Description: "Success" + TransactionReference: + CustomerContext: "string" + TransactionIdentifier: "string" + ServiceDate: "20260206" + PRN: "GPD49B1D615" + TriggerStatus: + Code: "02" + Description: "EXISTING" '400': description: Invalid Request content: @@ -2518,6 +2589,103 @@ components: name: Disclaimer description: Container to hold Disclaimer message applicable to taxes and charges. Available only when tax information is requested. + PICKUPTriggerGWNRequestWrapper: + xml: + name: PickupTriggerGWNRequest + description: + maximum: 1 + type: object + required: + - PickupTriggerGWNRequest + properties: + PickupTriggerGWNRequest: + "$ref": "#/components/schemas/PickupTriggerGWNRequest" + PICKUPTriggerGWNResponseWrapper: + xml: + name: PickupTriggerGWNResponse + description: + maximum: 1 + type: object + required: + - PickupTriggerGWNResponse + properties: + PickupTriggerGWNResponse: + "$ref": "#/components/schemas/PickupTriggerGWNResponse" + PickupTriggerGWNRequest: + type: object + description: Request to trigger a Smart Pickup (GWN - Green When Needed). + This flow applies to accounts enabled for Smart Pickup and supports + same-day or future-day pickup requests. Unlike regular Pickup Creation, + Smart Pickup does not require a separate Shipper object - it uses + the pickup address pre-configured on the UPS account. + required: + - Request + - AccountNumber + - ServiceDateOption + properties: + Request: + "$ref": "#/components/schemas/PickupCreationRequest_Request" + AccountNumber: + type: string + description: The UPS account number configured for Smart Pickup. + Must be a valid 6-character alphanumeric UPS account number + associated with the authenticated user. The pickup address + and notification preferences are retrieved from this account. + example: "1004YY" + minLength: 6 + maxLength: 6 + ServiceDateOption: + type: string + description: | + Specifies when the pickup should be scheduled. + - 01 -- Same Day - Request pickup for today + - 02 -- Future Day - Request pickup for next available business day + + If same-day is requested but cutoff time has passed,the pickup will be automatically scheduled for the next business day. + example: "01" + xml: + name: PickupTriggerGWNRequest + PickupTriggerGWNResponse: + type: object + description: Response from Smart Pickup trigger request. + properties: + Response: + "$ref": "#/components/schemas/PickupCreationResponse_Response" + ServiceDate: + type: string + description: The scheduled pickup date. + example: "20260128" + NextBusinessDayIndicator: + type: string + description: | + Indicates if the pickup was scheduled for the next business day instead + of the requested same-day pickup. Present only when same-day cutoff time has passed. + - Y -- Pickup scheduled for next business day. + example: "Y" + PRN: + type: string + description: Pickup Reference Number - unique identifier for the scheduled pickup. + Use this number to track or cancel the pickup. + example: "GPE58AB041C" + TriggerStatus: + "$ref": "#/components/schemas/PickupTriggerGWNResponse_TriggerStatus" + xml: + name: PickupTriggerGWNResponse + PickupTriggerGWNResponse_TriggerStatus: + type: object + description: Status of the Smart Pickup trigger operation + properties: + Code: + type: string + description: | + Status code indicating the result. + - 01 -- NEW - New pickup scheduled + - 02 -- EXISTING - Pickup already exists for this date + example: "01" + Description: + type: string + description: Human readable description of the trigger status. + example: "NEW" PICKUPPolDivRequestWrapper: xml: name: PickupGetPoliticalDivision1ListRequest From 0691495b6e6cf4a9b634798daf45785f3ee96ccc Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 11 Feb 2026 11:15:44 -0500 Subject: [PATCH 71/89] Update Shipping.yaml --- Shipping.yaml | 318 ++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 242 insertions(+), 76 deletions(-) diff --git a/Shipping.yaml b/Shipping.yaml index a61e4a4..eccfb67 100644 --- a/Shipping.yaml +++ b/Shipping.yaml @@ -313,7 +313,7 @@ paths: ShipmentServiceOptions: InternationalForms: FormType: '04' - FormGroupIdName: NAFTA Form + FormGroupIdName: USMCA Form Contacts: SoldTo: Option: " " @@ -2863,7 +2863,7 @@ paths: ShipmentServiceOptions: InternationalForms: FormType: '04' - FormGroupIdName: NAFTA Form + FormGroupIdName: USMCA Form Contacts: SoldTo: Option: " " @@ -4975,6 +4975,22 @@ components: type: string minLength: 2 maxLength: 2 + ShipperType: + description: |- + Shipment Value for ShipperType. 01 = Business 02 = Consumer/Individual NA = Not Applicable + Required for EU Inbound Shipments + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + ConsigneeType: + description: |- + Shipment Value for ConsigneeType. 01 = Business 02 = Consumer/Individual NA = Not Applicable + Required for EU Inbound Shipments + maximum: 1 + type: string + minLength: 2 + maxLength: 2 MasterCartonID: description: 'Master Carton ID. If Economy Service (17 or 72) : Economy Shipment will be associated with given Master Carton ID. If Non-Economy @@ -5667,7 +5683,7 @@ components: - 1051 = Singapore GST Registration Number - 1052 = ARN Registration Number - 1053 = IRD Registration Number - - 1054 = Malaysia Low Value Goods Sales Tax Registration + - 1054 = Malaysia Low Value Goods Sales Tax Registration Number Vendor Collect ID Number type code will be printed on commercial invoice if present. maximum: 1 @@ -5789,13 +5805,13 @@ components: type: string minLength: 2 maxLength: 2 - xml: - name: BillShipper + xml: + name: BillShipper description: Container for the BillShipper billing option. The three payment methods that are available for the Bill Shipper billing option are alternate payment method, account number or credit card. This element or its sibling element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator, must be - present but no more than one can be present. + present but no more than one can be present. BillShipper_CreditCard: type: object maximum: 1 @@ -6458,8 +6474,7 @@ components: - 83 = UPS Today Dedicated Courier - 84 = UPS Today Intercity - 85 = UPS Today Express - - 86 = UPS Today Express Saver - - 93 = Ground Saver + - 86 = UPS Today Express Saver - 96 = UPS Worldwide Express Freight. - C6 = Roadie XD AM (Morning delivery) - C7 = Roadie XD PM (Afternoon delivery) @@ -6950,7 +6965,7 @@ components: Valid values: - 01 - Invoice - 03 - CO - - 04 - NAFTA CO + - 04 - USMCA - 05 - Partial Invoice - 06 - Packinglist - 07 - Customer Generated Forms @@ -6976,9 +6991,9 @@ components: "$ref": "#/components/schemas/InternationalForms_CN22Form" AdditionalDocumentIndicator: description: "Presence of the indicator means user will supply additional - document, such as EEI, NAFTA_CO or CO. This indicator should be set when + document, such as EEI, USMCA or CO. This indicator should be set when the shipper intends to utilize UPS paperless invoice functionality AND - the shipper has SELF-PREPARED other International Forms (EEI, CO, NAFTACO) + the shipper has SELF-PREPARED other International Forms (EEI, CO, USMCA) to accompany the shipment. \nIt is evaluated only when: \n1. Account is paperless enabled. \n2. Movement requires an invoice.\n3. Destination country or territory accepts paperless invoice. \n4. Invoice data is supplied @@ -7060,7 +7075,7 @@ components: used by Customs. Examples of declarations that might be entered in this field are: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff treatment under - the NAFTA. I hereby certify that the information on this invoice is true + the USMCA. I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above. EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA @@ -7216,7 +7231,7 @@ components: type: string OverridePaperlessIndicator: description: The application will automatically provide a copy of the invoice - or NAFTA/CO with each response regardless of whether the user has enabled + or USMCA with each response regardless of whether the user has enabled Paperless account. The user now has the option to print or ignore the copy provided. maximum: 1 @@ -7235,7 +7250,8 @@ components: type: string xml: name: InternationalForms - description: International Forms information. + description: International Forms information. This is applicable to Trade Direct SMALLPACKAGE International Child + movements and not applicable to Trade Direct Master or Trade Direct LTL Child movements. InternationalForms_UserCreatedForm: type: object maximum: 13 @@ -7429,11 +7445,21 @@ components: type: string minLength: 40 maxLength: 40 + DDSReferenceNumber: + "$ref": "#/components/schemas/CN22Content_CN22DDSReferenceNumber" xml: name: CN22Content description: "Container for CN22 content. Required if the CN22 form container is present. \nNote: The maximum number of goods printed on the CN22 form when a combined MI package and CN22 form label is requested is 30." + CN22Content_CN22DDSReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: holds a list of DDS Reference Numbers + maximum: 5 + type: string CN22Content_CN22ContentWeight: type: object required: @@ -7609,9 +7635,9 @@ components: xml: name: Contacts description: Holds the contact information of various parties. Applicable for - EEI and NAFTA CO only. Required for NAFTA CO and EEI. Ultimate consignee contact + EEI and USMCA only. Required for USMCA and EEI. Ultimate consignee contact information is required for EEI. Producer contact information is required - for NAFTA CO + for USMCA maximum: 1 Contacts_ForwardAgent: type: object @@ -7873,7 +7899,7 @@ components: list of additional producers, including the legal name, address (including country or territory), and legal tax identification number, cross-referenced to the goods described in the Description of Goods field. Applies to - NAFTA CO. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02 + USMCA. \nValid values: \n01 - AVAILABLE TO CUSTOMS UPON REQUEST\n02 - SAME AS EXPORTER\n03 - ATTACHED LIST\n04 - UNKNOWN" maximum: 1 type: string @@ -7881,14 +7907,14 @@ components: maxLength: 2 CompanyName: description: 'Company Name or the Individual name of the Producer. Applies - to NAFTA CO. Only applicable when producer option is empty or not present. - Conditionally required for: NAFTA CO, when Producer option is not specified.' + to USMCA. Only applicable when producer option is empty or not present. + Conditionally required for: USMCA, when Producer option is not specified.' maximum: 1 type: string minLength: 1 maxLength: 35 TaxIdentificationNumber: - description: Tax ID of the Producer. Applies to NAFTA CO. Only applicable + description: Tax ID of the Producer. Applies to USMCA. Only applicable when producer option is empty or not present maximum: 1 type: string @@ -7897,7 +7923,7 @@ components: Address: "$ref": "#/components/schemas/Producer_Address" AttentionName: - description: Contact name at the Producer location. Applies to NAFTA CO. + description: Contact name at the Producer location. Applies to USMCA. maximum: 1 type: string minLength: 1 @@ -7905,18 +7931,18 @@ components: Phone: "$ref": "#/components/schemas/Producer_Phone" EMailAddress: - description: Producer email address. Applies to NAFTA CO. + description: Producer email address. Applies to USMCA. maximum: 1 type: string minLength: 1 maxLength: 50 xml: name: Producer - description: "Information of the producer. The NAFTA Certificate of Origin must + description: "Information of the producer. The USMCA Certificate of Origin must be completed, signed, and dated by the exporter. \nWhen the Certificate is completed by the producer for use by the exporter, it must be completed, signed, and dated by the producer. The date must be the date the Certificate was completed - and signed. Applies to NAFTA CO. Required for NAFTA CO forms." + and signed. Applies to USMCA. Required for USMCA forms." Producer_Address: type: object maximum: 1 @@ -7934,13 +7960,13 @@ components: minLength: 1 maxLength: 35 City: - description: "City of the Producer. Applies to NAFTA CO. Conditionally required for: NAFTA CO, when Producer option is not specified." + description: "City of the Producer. Applies to USMCA. Conditionally required for: USMCA, when Producer option is not specified." maximum: 1 type: string minLength: 1 maxLength: 30 StateProvinceCode: - description: State of the Producer. Applies to NAFTA CO. Required for certain countries or territories. + description: State of the Producer. Applies to USMCA. Required for certain countries or territories. maximum: 1 type: string minLength: 1 @@ -7952,22 +7978,22 @@ components: minLength: 1 maxLength: 30 PostalCode: - description: Postal code of the Producer. Applies to NAFTA CO. Required for certain countries or territories. The length of the postal code depends on the country or territory code. + description: Postal code of the Producer. Applies to USMCA. Required for certain countries or territories. The length of the postal code depends on the country or territory code. maximum: 1 type: string minLength: 1 maxLength: 9 CountryCode: - description: Country or Territory code of the Producer. Applies to NAFTA CO. + description: Country or Territory code of the Producer. Applies to USMCA. maximum: 1 type: string minLength: 2 maxLength: 2 xml: name: Address - description: 'Address information of the Producer. Applies to NAFTA CO. Only + description: 'Address information of the Producer. Applies to USMCA. Only applicable if producer option is empty or not present. Conditionally required - for: NAFTA CO, when Producer option is not specified.' + for: USMCA, when Producer option is not specified.' Producer_Phone: type: object maximum: 1 @@ -7975,20 +8001,20 @@ components: - Number properties: Number: - description: The locations phone number of the Producer. Applies to NAFTA CO. + description: The locations phone number of the Producer. Applies to USMCA. maximum: 1 type: string minLength: 1 maxLength: 15 Extension: - description: The locations phone extension of the Producer. Applies to NAFTA CO. + description: The locations phone extension of the Producer. Applies to USMCA. maximum: 1 type: string minLength: 1 maxLength: 4 xml: name: Phone - description: Phone number information of Producer. Applies to NAFTA CO. + description: Phone number information of Producer. Applies to USMCA. Contacts_SoldTo: type: object maximum: 1 @@ -8019,7 +8045,7 @@ components: Phone: "$ref": "#/components/schemas/SoldTo_Phone" Option: - description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02." + description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02." maximum: 1 type: string minLength: 2 @@ -8042,8 +8068,8 @@ components: name: SoldTo description: SoldTo Container. The Sold To party's country code must be the same as the Ship To party's country code with the exception of Canada and - satellite countries. Applies to Invoice and NAFTA CO Forms. Required if Invoice - or NAFTA CO (International Form) is requested. + satellite countries. Applies to Invoice and USMCA Forms. Required if Invoice + or USMCA (International Form) is requested. SoldTo_Phone: type: object maximum: 1 @@ -8074,7 +8100,7 @@ components: - CountryCode properties: AddressLine: - description: SoldTo location's street address. Applies to NAFTA CO. + description: SoldTo location's street address. Applies to USMCA. maximum: 3 type: array items: @@ -8113,7 +8139,7 @@ components: maxLength: 2 xml: name: Address - description: Sold To Address Container. Applies to NAFTA CO. + description: Sold To Address Container. Applies to USMCA. InternationalForms_Product: type: object maximum: 1 @@ -8135,8 +8161,8 @@ components: CommodityCode: description: '6-to-15-alphanumeric commodity code. Customs uses this code to determine what duties should be assessed on the commodity. Applies - to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional - for Partial Invoice. Should be at least 6 alphanumeric. For NAFTA CO: + to Invoice, Partial Invoice and USMCA. Required for USMCA and optional + for Partial Invoice. Should be at least 6 alphanumeric. For USMCA: For each good described in Description of Goods field, identify the H.S. tariff classification to six digits. If the good is subject to a specific rule of origin in Annex 401 that requires eight digits, identify to eight @@ -8167,13 +8193,13 @@ components: maxLength: 2 JointProductionIndicator: description: If present, JNT will be used as the origin of country or territory - code on the NAFTA form and the Product/Origincountry or territoryCode - tag will be ignored. Applies to NAFTA CO only. + code on the USMCA form and the Product/Origincountry or territoryCode + tag will be ignored. Applies to USMCA only. maximum: 1 type: string NetCostCode: description: | - For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to NAFTA CO only. Required for NAFTA CO. Valid values: + For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values: - NC - ND - NO @@ -8189,7 +8215,7 @@ components: are contained in Chapter Four and Annex 401. \n\nAdditional rules are described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix 6 (certain textile goods) and Annex 308.1 (certain automatic data processing - goods and their parts). Applies to NAFTA CO only." + goods and their parts). Applies to USMCA only." maximum: 1 type: string minLength: 1 @@ -8201,7 +8227,7 @@ components: an originating good. \nNo [2] - Reliance on the producers written representation (other than a Certificate of Origin) that the good qualifies as an originating good. \nNo [3] - A completed and signed Certificate for the good voluntarily - provided to the exporter by the producer. Applicable for NAFTA CO and + provided to the exporter by the producer. Applicable for USMCA and is required. Valid values: Yes, No [1], No [2], and No [3]." maximum: 1 type: string @@ -8267,13 +8293,15 @@ components: "$ref": "#/components/schemas/Product_PackingListInfo" EEIInformation: "$ref": "#/components/schemas/Product_EEIInformation" + DDSReferenceNumber: + "$ref": "#/components/schemas/Product_DDSReferenceNumber" xml: name: Product description: "Contains the commodity/product information. Applies to EEI, Invoice, - Partial Invoice, CO and NAFTA CO. When any International form is requested, + Partial Invoice, CO and USMCA. When any International form is requested, at least one Product must be present. \n\nMaximum number of products allowed for different forms are:\n\n50: Package Packing List\n\n100: Commercial Invoice, - NAFTA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice + USMCA, CO, EEI\n\n1000: Air Freight packing list\n\nNote: For Partial Invoice this container is optional." Product_Unit: type: object @@ -8348,7 +8376,7 @@ components: BeginDate: description: 'If the RVC is calculated over a period of time, it should be identified by the begin date (yyyyMMdd) of that period. (Reference: - Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.' + Articles 402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.' maximum: 1 type: string minLength: 8 @@ -8356,14 +8384,14 @@ components: EndDate: description: 'If the RVC is calculated over a period of time, it should be identified by the End date (yyyyMMdd) of that period. (Reference: Articles - 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.' + 402.1, 402.5). Applies to USMCA only. Format is yyyyMMdd.' maximum: 1 type: string minLength: 8 maxLength: 8 xml: name: NetCostDateRange - description: Date Range for regional value content (RVC). Applies to NAFTA + description: Date Range for regional value content (RVC). Applies to USMCA CO only. Product_ProductWeight: type: object @@ -8480,7 +8508,7 @@ components: - FormType properties: FormType: - description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – NAFTA CO. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED. + description: Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – USMCA. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED. type: array items: type: string @@ -8533,6 +8561,14 @@ components: description: |- Data Container holding package/product related information that will break up the product into each package on the packing list. Total product amount must equal the product unit value above. Required for packaging list and Air Freight Packing list. Packaging list max allowed : 20 Air Freight Packaging list max allowed: 200 + Product_DDSReferenceNumber: + type: object + maximum: 1 + properties: + Number: + description: holds a list of DDS Reference Numbers + maximum: 5 + type: string Product_EEIInformation: type: object maximum: 1 @@ -8774,7 +8810,7 @@ components: description: Begin date of the blanket period. It is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). Applies - to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This + to USMCA form only. Required for USMCA. Format is yyyyMMdd. This is not valid for a paperless shipment. maximum: 1 type: string @@ -8782,7 +8818,7 @@ components: maxLength: 8 EndDate: description: End Date of the blanket period. It is the date upon which the - blanket period expires. Applies to NAFTA CO form only. Required for NAFTA + blanket period expires. Applies to USMCA form only. Required for USMCA CO. Format is yyyyMMdd. This is not valid for a paperless shipment. maximum: 1 type: string @@ -8790,12 +8826,12 @@ components: maxLength: 8 xml: name: BlanketPeriod - description: This field should be entered if the NAFTA Certificate covers multiple + description: This field should be entered if the USMCA Certificate covers multiple shipments of identical goods as described in the Description of Goods field - that are imported into a NAFTA country or territory for a specified period + that are imported into a USMCA country or territory for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between - these dates. Applies to NAFTA CO form only. Required for NAFTA CO. This + these dates. Applies to USMCA form only. Required for USMCA. This is not valid for a paperless shipment. ShipmentServiceOptions_DeliveryConfirmation: type: object @@ -9106,8 +9142,8 @@ components: name: Package required: - Packaging - description: Package Information container. For Return Shipments up to and - including 20 packages are allowed. US/PR origin return movements are limited + description: Package Information container. For Return Shipments up to + 20 packages are allowed. US/PR origin return movements are limited to only one package. For Mail Innovations and Simple Rate shipments only one package is allowed. Shipment_TradeDirect: @@ -9122,7 +9158,7 @@ components: $ref: '#/components/schemas/TradeDirect_Child' GeneralDescriptionOfGoods: description: General description of the goods being shipped. It is required for master shipment. - pattern: ^[a-zA-Z0-9 ]{1,100}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]+$ type: string ShipmentType: description: | @@ -9142,7 +9178,7 @@ components: CurrencyCode: description: The currency code for the shipment as per ISO 4217. type: string - pattern: ^[A-Z]{3}$ + pattern: ^(?!\s*$)[A-Z]{3}$ xml: name: TradeDirect maximum: 1 @@ -9195,12 +9231,14 @@ components: type: string minLength: 1 maxLength: 35 + pattern: ^(?!\s*$).{1,35}$ AttentionName: description: Master Sold to Contact Name. maximum: 1 type: string minLength: 1 maxLength: 35 + pattern: ^.{0,35}$ TaxIdentificationNumber: deprecated: true description: Master Sold To Tax Identification Number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container. @@ -9211,7 +9249,7 @@ components: Phone: $ref: '#/components/schemas/TradeDirect_Phone' Option: - description: "The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02." + description: "The text associated with the code will be printed in the sold to section of the USMCA form. The values indicate the following: 01 – Unknown. Applies to USMCA form. Possible Values are 01 and 02." maximum: 1 type: string minLength: 2 @@ -9247,12 +9285,14 @@ components: type: string minLength: 1 maxLength: 35 + pattern: ^(?!\s*$).{1,35}$ AttentionName: description: Master Pickup Contact Name. maximum: 1 type: string minLength: 1 maxLength: 35 + pattern: ^.{0,35}$ Phone: $ref: '#/components/schemas/TradeDirect_Phone' Address: @@ -9296,12 +9336,12 @@ components: description: Primary address line includes street number and street name (when applicable). maximum: 3 type: string - pattern: ^[A-Za-z0-9\s.,#/-]{1,35}$ + pattern: ^(?!\s*$).{1,35}$ example: 123 South Main St City: description: The name of the city for the address. type: string - pattern: ^[a-zA-Z\s.,]{1,35}$ + pattern: ^(?!\s*$).{1,35}$ example: Atlanta StateProvinceCode: description: The code for the state or province for the address. @@ -9360,15 +9400,15 @@ components: maxLength: 150 DeclarationStatement: description: | - The type of declaration statement. Can be invoice or NAFTA. + The type of declaration statement. Can be invoice or USMCA. Valid values: - Invoice = Invoice declaration - - NAFTA = NAFTA declaration + - USMCA = USMCA declaration type: string - enum: ["Invoice", "NAFTA"] + enum: ["Invoice", "USMCA"] xml: name: TradeComplianceDetails description: 'Contains trade compliance details for the master shipment, such as invoice terms, export reasons, and declaration statements. It also includes additional comments or instructions for customs clearance.' @@ -9397,10 +9437,11 @@ components: Valid values: - LTL - - SMALLPACKAGE + - SMALLPACKAGE + - MI type: string - enum: ["LTL", "SMALLPACKAGE"] + enum: ["LTL", "SMALLPACKAGE", "MI"] Product: $ref: '#/components/schemas/Child_Product' LtlPackage: @@ -9424,7 +9465,7 @@ components: Description: description: Description of the product being shipped. type: string - pattern: ^[a-zA-Z0-9 ]{1,100}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,100}$ example: ALPHA BRAIN INSTANT PEACH UnitPrice: description: Price per unit of the product being shipped. @@ -9440,7 +9481,7 @@ components: description: Product number of the product being shipped. type: string example: IDID767640 - pattern: ^[a-zA-Z0-9 ]{1,20}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,20}$ CountryOriginCode: description: Country code of the product being shipped. type: string @@ -9493,6 +9534,123 @@ components: type: string enum: [ "BA", "BE", "BG", "BH", "BOX", "BT", "LB", "LBS", "L", "M", "NMB", "PA", "BU", "CI", "CM", "CON", "CR", "CS", "CT", "CY", "DOZ", "EA", "EN", "FT", "KG", "KGS", "PAL", "PC", "PCS", "PF", "OTH", "PKG", "PR", "PRS", "RL", "SET", "SME", "SYD", "TU", "YD" ] + CommodityCode: + description: '6-to-15-alphanumeric commodity code. Customs uses this code + to determine what duties should be assessed on the commodity. Applies + to Invoice, Partial Invoice and USMCA. Required for USMCA and optional + for Partial Invoice. Should be at least 6 alphanumeric. For USMCA: + For each good described in Description of Goods field, identify the H.S. + tariff classification to six digits. If the good is subject to a specific + rule of origin in Annex 401 that requires eight digits, identify to eight + digits, using the H.S. tariff classification of the country or territory + into whose territory the good is imported.' + maximum: 1 + type: string + minLength: 6 + maxLength: 15 + JointProductionIndicator: + description: If present, JNT will be used as the origin of country or territory + code on the USMCA form and the Product/Origincountry or territoryCode + tag will be ignored. Applies to USMCA only. + maximum: 1 + type: string + NetCostCode: + description: | + For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to USMCA only. Required for USMCA. Valid values: + - NC + - ND + - NO + maximum: 1 + type: string + minLength: 2 + maxLength: 2 + NetCostDateRange: + "$ref": "#/components/schemas/Product_NetCostDateRange" + PreferenceCriteria: + description: "Indicates the criterion (A through F) for each good described + in the Description of Goods field if applicable. \n\nThe rules of origin + are contained in Chapter Four and Annex 401. \n\nAdditional rules are + described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix + 6 (certain textile goods) and Annex 308.1 (certain automatic data processing + goods and their parts). Applies to USMCA only." + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + ProducerInfo: + description: "Indicate the following: Yes - If shipper is the producer + of the good. If not, state 02, 03, and 04 depending on whether this certificate + was based upon: \nNo [1] - Knowledge of whether the good qualifies as + an originating good. \nNo [2] - Reliance on the producers written representation + (other than a Certificate of Origin) that the good qualifies as an originating + good. \nNo [3] - A completed and signed Certificate for the good voluntarily + provided to the exporter by the producer. Applicable for USMCA and + is required. Valid values: Yes, No [1], No [2], and No [3]." + maximum: 1 + type: string + minLength: 3 + maxLength: 5 + MarksAndNumbers: + description: Any special marks, codes, and numbers that may appear on package. Applies + to CO Only. + maximum: 1 + type: string + minLength: 1 + maxLength: 35 + NumberOfPackagesPerCommodity: + description: The total number of packages, cartons, or containers for the + commodity. Applicable for CO and is required. Should be numeric. Valid + characters are 0 -9. + maximum: 1 + type: string + minLength: 1 + maxLength: 3 + ProductWeight: + "$ref": "#/components/schemas/Product_ProductWeight" + VehicleID: + description: 'Includes the following information for used self-propelled + vehicles as defined in Customs regulations 19 CFR 192.1: The unique Vehicle + Identification Number (VIN) in the proper format. Or The Product Identification + Number (PIN) for those used self-propelled vehicles for which there are + no VINs. Or the Vehicle Title Number. Applies to EEI forms only.' + maximum: 1 + type: string + minLength: 1 + maxLength: 25 + ScheduleB: + "$ref": "#/components/schemas/Product_ScheduleB" + ExportType: + description: 'Code indicating Domestic: Exports that have been produced, + manufactured, or grown in the United States or Puerto Rico. This includes + imported merchandise which has been enhanced in value or changed from + the form in which imported by further manufacture or processing in the + United States or Puerto Rico. Foreign: Merchandise that has entered the + United States and is being exported again in the same condition as when + imported. Applies to EEI forms only. Required for EEI form. Valid values: D: + Domestic; F: Foreign.' + maximum: 1 + type: string + minLength: 1 + maxLength: 1 + SEDTotalValue: + description: | + This amount will always be USD. Applies to EEI forms only. Required for EEI form. Valid characters are 0-9 and \'.\' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including \'.\' and can hold up to 2 decimal places. + + Note: This value is calculated based on the Product/Unit/Value and /Product/Unit/Number (Number of Units * Price per Unit). If the total value is incorrect it will be replaced by the actual calculated total value. + maximum: 1 + type: string + minLength: 1 + maxLength: 15 + TaxesPaid: + description: "Invoice Commodity Level Tax Collected Code for each shipment commodity line.Taxes paid Indicator is only applicable for shipments to Singapore. [TaxesPaid = 0 - No on Report], [TaxesPaid = 1 -Yes on Report], [TaxesPaid = empty - null on Report], [If TaxesPaid is not passed in input request = null on Report]" + type: string + ExcludeFromForm: + "$ref": "#/components/schemas/Product_ExcludeFromForm" + PackingListInfo: + "$ref": "#/components/schemas/Product_PackingListInfo" + EEIInformation: + "$ref": "#/components/schemas/Product_EEIInformation" + xml: name: Product description: This variable represents the product details. It is used to provide information about the product being shipped. @@ -9713,7 +9871,7 @@ components: description: 'Description of what the other charges are for.' type: string example: Miscellaneous charge - pattern: ^[a-zA-Z0-9 ]{1,30}$ + pattern: ^(?!\s*$)[a-zA-Z0-9 ]{1,30}$ xml: name: OtherCharges description: 'Any other miscellaneous charges.' @@ -13821,11 +13979,16 @@ components: maximum: 1 properties: AgentRole: - description: '(SHIP_FROM=20, CONSIGNEE=30)' + description: 'When the value passed to the AgentRole parameter is 30, + the value passed to the IDNumberTypeCode parameter must be 1002, 1005 or 0005. + (SHIP_FROM=20, CONSIGNEE=30)' type: string TaxIdentificationNumber: - $ref: >- - #/components/schemas/AgentTaxIdentificationNumber_TaxIdentificationNumber + items: + $ref: >- + #/components/schemas/AgentTaxIdentificationNumber_TaxIdentificationNumber + maximum: 8 + type: array required: - AgentRole type: object @@ -13984,8 +14147,11 @@ components: minLength: 2 maxLength: 2 AgentTaxIdentificationNumber: - $ref: >- - #/components/schemas/GlobalTaxInformation_AgentTaxIdentificationNumber + type: array + items: + $ref: >- + #/components/schemas/GlobalTaxInformation_AgentTaxIdentificationNumber + maximum: 4 type: object xml: name: GlobalTaxInformation From 243ab39b50448d85711914cd11f6cb0059214784 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 11 Feb 2026 11:20:25 -0500 Subject: [PATCH 72/89] Update Pickup.yaml --- Pickup.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Pickup.yaml b/Pickup.yaml index 6c1855d..1e54078 100644 --- a/Pickup.yaml +++ b/Pickup.yaml @@ -339,7 +339,7 @@ paths: required: true content: application/json: - schema: + schema: oneOf: - $ref: "#/components/schemas/PICKUPCreationRequestWrapper" - $ref: "#/components/schemas/PICKUPTriggerGWNRequestWrapper" @@ -398,7 +398,7 @@ paths: TransactionReference: CustomerContext: "Smart Pickup Request" AccountNumber: "1004YY" - ServiceDateOption: "01" + ServiceDateOption: "01" responses: '200': description: successful operation @@ -2685,7 +2685,7 @@ components: Description: type: string description: Human readable description of the trigger status. - example: "NEW" + example: "NEW" PICKUPPolDivRequestWrapper: xml: name: PickupGetPoliticalDivision1ListRequest From 4d8b7818f384b92c5eede1a72fa482ab7165ff35 Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 11 Feb 2026 13:31:18 -0500 Subject: [PATCH 73/89] Add files via upload --- CustomsDetailV2.yaml | 1252 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1252 insertions(+) create mode 100644 CustomsDetailV2.yaml diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml new file mode 100644 index 0000000..8802908 --- /dev/null +++ b/CustomsDetailV2.yaml @@ -0,0 +1,1252 @@ +openapi: 3.1.0 +info: + title: UGC Customs Detail API v2 + version: "1.0" + description: > + Informs clients of the latest compliance needs for fields to be collected at the creation of UPS Brokerage shipments. + This API can then validate the values for these fields and accept them for merging to a shipment in the backend. + + **Key Business Values:** + - keeps clients updated with latest compliance needs + - field data collection can be handled through user configuration + - the flexible framework removes the need for additional code changes as fields change +servers: + - url: https://www.livesite.ups.com/trade/compliance/{version} + description: URL for JWT based authentication that can be used for any environment (production, staging, product test) via hosts file. + variables: + version: + default: v2 + enum: + - v2 + - url: https://onlinetools.ups.com/api/trade/compliance/{version} + description: URL for Oauth based authentication that can be used for any environment (production, staging, product test) via hosts file. + variables: + version: + default: v2 + enum: + - v2 + - url: https://wwwcie.ups.com/api/trade/compliance/{version} + description: UPS Production CIE + variables: + version: + default: v2 + enum: + - v2 +tags: + - name: Field Data + description: Endpoints related to the required fields +paths: + /content/fields/customs-detail: + post: + summary: validate and/or submit the fields + description: This endpoint will provide the ability to validate and/or submit the additional field information for a shipment + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - name: registrationId + in: header + required: false + schema: + type: string + description: Used to confirm prsence of active account for Worldship clients + example: 3DA124234342 + operationId: postCustomDetailData + security: + - oauth2: [] + - oauthCie: [] + - JWTAuth: [] + tags: + - Field Data + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CustomDetailsPostFieldsRequestv2" + example: + actionType: save + shipperNumber: 1443YY + trackingNumber: 1Z1443YY0161231327 + shipmentMetaData: + - groupKey: US-IMP-CDC + fields: + - fieldKey: ImportLicenseNumber + regulationSections: + - sectionKey: Bio + fieldValue: "123412351234123" + - groupKey: IN-EXP-CSB + fields: + - fieldKey: CSBType + regulationSections: + - sectionKey: CSB + fieldValue: "3" + - fieldKey: IECCode + regulationSections: + - sectionKey: CSB + fieldValue: "99" + products: + - productId: PART-001 + productDescription: Medical device + commodityCode: "3821000010" + productMetaData: + - groupKey: IN-EXP-CSB + fields: + - fieldKey: Amount + regulationSections: + - sectionKey: CSB + fieldValue: "10" + - fieldKey: CurrencyCode + regulationSections: + - sectionKey: CSB + fieldValue: USD + - groupKey: US-IMP-FDA + fields: + - fieldKey: MnuNa + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: UPS Labs + - fieldKey: MnuAdLn1Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "55 Glenlake Pkwy NE" + - fieldKey: MnuAdLn2Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Suite 400" + - fieldKey: MnuAdLn3Te + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Building C" + - fieldKey: MnuCtyNa + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "Atlanta" + - fieldKey: MnuStPrvCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "GA" + - fieldKey: MnuCtyCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "US" + - fieldKey: MnuPslCd + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + fieldValue: "30301" + - productId: PART-002 + productDescription: Sample pharma goods + commodityCode: "300490" + productMetaData: + - groupKey: US-IMP-FDA + fields: + - fieldKey: MnuNa + regulationSections: + - sectionKey: Cos + fieldValue: UPS Labs + - fieldKey: MnuPslCd + regulationSections: + - sectionKey: Cos + fieldValue: "30301" + - fieldKey: MnuAdLn1Te + regulationSections: + - sectionKey: Cos + fieldValue: 55 Glenlake Pkwy NE + - fieldKey: MnuCtyNa + regulationSections: + - sectionKey: Cos + fieldValue: Atlanta + - fieldKey: MnuStPrvCd + regulationSections: + - sectionKey: Cos + fieldValue: GA + - fieldKey: MnuCtyCd + regulationSections: + - sectionKey: Cos + fieldValue: US + responses: + "204": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + "400": + $ref: '#/components/responses/BadRequest' + "401": + $ref: '#/components/responses/Unauthorized' + "422": + $ref: '#/components/responses/UnprocessableEntity' + "500": + $ref: '#/components/responses/ServerError' + get: + summary: returns required custom details + description: This returns an array of fields that are required for the provided import and/or export country + parameters: + - $ref: "#/components/parameters/transId" + - $ref: "#/components/parameters/transactionSrc" + - $ref: "#/components/parameters/Content-Type" + - name: import_country_code + in: query + required: false + schema: + type: + - string + - "null" + description: | + The ISO 3166 country or territory code + from where the shipment is being imported to. If this is omitted then all import fields for all countries will be returned + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: US + - name: export_country_code + in: query + required: false + schema: + type: + - string + - "null" + description: | + The ISO 3166 country or territory code + from where the shipment is being exported from. If this is omitted then all export fields for all countries will be returned + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: IT + - name: locale + in: query + required: false + schema: + type: string + description: "" + minLength: 5 + maxLength: 5 + pattern: ^[a-z]{2}-[A-Z]{2}$ + default: en-US + example: en-US + - name: commodity_codes + in: query + required: false + description: Optional comma-separated list of tariff codes to filter results. + schema: + type: + - string + - "null" + minLength: 1 + maxLength: 2000 + example: "2926400000,3003395000" + operationId: getCustomDetailData + security: + - oauth2: [] + - oauthCie: [] + - JWTAuth: [] + tags: + - Field Data + responses: + "200": + description: Success + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + TransId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomDetailsGetFieldsSuccessResponsev2" + example: + commodityCodes: + - commodityCode: "2926400000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + - commodityCode: "3003395000" + regulations: + - regulation: FDA + regulationSections: + - sectionKey: DRU + fieldGroups: + - countryCode: US + countryName: UNITED STATES OF AMERICA + shipmentType: Import + groupKey: US-IMP-FDA + details: This is for US import FDA fields + regulation: FDA + regulationSections: + - sectionKey: Cos + sectionName: Cosmetics + - sectionKey: Bio + sectionName: Biologics + - sectionKey: Dev + sectionName: Device + - sectionKey: Foo + sectionName: Food + fields: + - sectionKey: MnuNa + label: Manufacturer Name + order: "1" + tooltip: Type of shipping bill to be processed for the shipment + isRequired: C + requirementConditions: + - fieldKey: MnuPslCd + operator: "!=" + value: "" + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerName + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "8" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + - sectionKey: MnuAdLn1Te + label: Manufacturer Address Line 1 + order: "1" + tooltip: Line 1 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine1 + level: Product + - sectionKey: MnuAdLn2Te + label: Manufacturer Address Line 2 + order: "1" + tooltip: Line 2 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine2 + level: Product + - sectionKey: MnuAdLn3Te + label: Manufacturer Address Line 3 + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuCtyNa + label: Manufacturer City Name + order: "1" + tooltip: Line 3 of the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerAddressLine3 + level: Product + - sectionKey: MnuStPrvCd + label: Manufacturer State/Province Code + order: "1" + tooltip: The state/province for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerStateProvinceCode + level: Product + - sectionKey: MnuCtyCd + label: Manufacturer Country Code + order: "1" + tooltip: The country code for the address of the manufacturer for the product + isRequired: N + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerCountryCode + level: Product + - sectionKey: MnuPslCd + label: Manufacturer Postal Code + order: "1" + tooltip: The postal code address of the manufacturer for the product + isRequired: Y + requirementConditions: null + fieldType: textbox + allowedValueCount: 1 + validation: + minLength: null + maxLength: null + errorMessage: Enter a valid value + dataType: Text + regexPattern: null + listValues: [] + regulationSections: + - sectionKey: Cos + - sectionKey: Bio + - sectionKey: Dev + - sectionKey: Foo + keyAlias: ManufacturerPostalCode + level: Product + "401": + $ref: '#/components/responses/Unauthorized' + "422": + $ref: '#/components/responses/UnprocessableEntity' + "500": + $ref: '#/components/responses/ServerError' +components: + securitySchemes: + oauth2: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://onlinetools.ups.com/security/v2/oauth/token + scopes: {} + oauthCie: + type: oauth2 + description: | + Find your Client ID and Secret on your app info page. + 1. Select "Try It" + 2. In the Security section enter your Client ID and Secret + 3. Select "Request Token" + 4. Enter any additional information in the Body and Parameters sections + 5. Select "Send" to execute your API request" + flows: + clientCredentials: + x-tokenEndpointAuthMethod: client_secret_basic + tokenUrl: https://wwwcie.ups.com/security/v2/oauth/token + scopes: {} + JWTAuth: + type: "http" + scheme: bearer + bearerFormat: JWT + parameters: + transId: + name: transId + in: header + required: true + schema: + type: string + description: Transaction Id + transactionSrc: + name: transactionSrc + in: header + required: true + schema: + type: string + description: Identifies the clients/source application that is calling + Content-Type: + name: Content-Type + in: header + required: true + schema: + type: string + description: accepted value application/json + headers: + BkndTransId: + description: The backend transaction id. + schema: + type: string + example: 383f7d397a48 + transId: + description: An identifier unique to the request. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]+$ + maxLength: 512 + example: 0a1b9c2d8e3f7g4h6i5 + transactionSrc: + description: Identifies the client/source application that is calling. + schema: + type: string + pattern: ^[a-zA-Z0-9-.]+$ + maxLength: 512 + example: UPS.com + Content-Type: + description: The Content-Type header provides the client with the actual content/media type of the returned content. + schema: + type: string + example: application/json + APIErrorCode: + description: The API error code. + schema: + type: string + example: UJ0001 + APIErrorMsg: + description: The API error message. + schema: + type: string + example: Invalid token or token is not present. + responses: + BadRequest: + description: Bad Request + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CustomDetailsErrorResponsev2' + example: + response: + errors: + - code: "105.000" + message: Malformed JSON request + - code: "105.004" + message: Field value is required + description: "VALUE_REQUIRED" + field: "shipperNumber" + value: null + Unauthorized: + description: Unauthorized + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CustomDetailsErrorResponsev2' + example: + response: + errors: + - code: "105.401" + message: Invalid token or token is not present + description: null + field: null + value: null + UnprocessableEntity: + description: Unprocessable Entity + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: "#/components/schemas/CustomDetailsErrorResponsev2" + example: + response: + errors: + - code: "105.001" + description: INVALID_FIELD + field: importCountryCode + message: Supplied value was not in the correct range of valid values. + value: USA + ServerError: + description: Server Error + headers: + BkndTransId: + $ref: "#/components/headers/BkndTransId" + transId: + $ref: "#/components/headers/transId" + transactionSrc: + $ref: "#/components/headers/transactionSrc" + Content-Type: + $ref: "#/components/headers/Content-Type" + APIErrorCode: + $ref: "#/components/headers/APIErrorCode" + APIErrorMessage: + $ref: "#/components/headers/APIErrorMsg" + content: + application/json: + schema: + $ref: '#/components/schemas/CustomDetailsErrorResponsev2' + example: + response: + errors: + - code: "105.500" + message: Internal Server Error + description: INTERNAL_ERROR + field: null + value: null + schemas: + #/content/fields/customs-detail + CustomDetailsPostFieldsRequestv2: + type: object + description: Container for the posting of field data + properties: + shipperNumber: + type: string + description: This represents the shipper account number. Required when actionType is save. + minLength: 6 + maxLength: 6 + example: X5R660 + actionType: + type: string + description: Specify the intent of the request. 'Save' will inherently perform validation. + enum: + - validate + - save + trackingNumber: + type: string + description: Tthe lead 1Z number fore the shipment. Required when actionType is save. + minLength: 18 + maxLength: 18 + pattern: ^1Z[0-9A-Z]{16}$ + example: 1Z1234567891234560 + shipmentMetaData: + $ref: '#/components/schemas/CustomDetailsRequestMetaDatav2' + products: + type: array + description: Unbounded list of containers for products included on the shipment being updated + minItems: 1 + items: + type: object + properties: + productId: + type: string + description: An identifier for the product + minLength: 1 + maxLength: 50 + example: PROD-001 + productDescription: + type: string + description: The description of the product + minLength: 1 + maxLength: 105 + example: Sample pharma goods + commodityCode: + $ref: '#/components/schemas/CustomDetailsCommodityCodev2' + productMetaData: + $ref: '#/components/schemas/CustomDetailsRequestMetaDatav2' + additionalProperties: false + required: + - productId + - productDescription + - productMetaData + additionalProperties: false + required: + - actionType + CustomDetailsGetFieldsSuccessResponsev2: + type: object + description: Contains commodity code groupings and the detailed field metadata required per country, process, and Regulation. + properties: + commodityCodes: + type: array + description: Unbounded list of commodity codes and their associated compliance Regulations. + items: + type: object + properties: + commodityCode: + $ref: '#/components/schemas/CustomDetailsCommodityCodev2' + regulations: + type: array + description: Regulations that require additional data for this commodity code. + minItems: 1 + items: + type: object + properties: + regulation: + $ref: '#/components/schemas/CustomDetailsRegulationv2' + regulationSections: + $ref: '#/components/schemas/CustomDetailsRegulationSectionv2' + additionalProperties: false + required: + - regulation + - regulationSections + additionalProperties: false + required: + - commodityCode + - regulations + fieldGroups: + type: array + description: Unbounded list of field group definitions grouped by country, shipment type, and Regulation. + minItems: 1 + items: + type: object + properties: + countryCode: + type: string + description: The ISO 3166 country or territory code the fields pertain to. + minLength: 2 + maxLength: 2 + pattern: ^[A-Z]{2}$ + example: US + countryName: + type: string + description: Country name the fields apply to. + example: UNITED STATES OF AMERICA + shipmentType: + type: string + description: Indicates what direction of movement the fields pertain to. + oneOf: + - title: Fields for import movment + const: Import + - title: Fields for export movement + const: Export + - title: Fields for both movements + const: Both + groupKey: + $ref: '#/components/schemas/CustomDetailsGroupKeyv2' + details: + type: string + description: Provides details on why and when the information is needed. + example: This is for US import FDA fields + regulation: + $ref: '#/components/schemas/CustomDetailsRegulationv2' + regulationSections: + $ref: '#/components/schemas/CustomDetailsRegulationSectionv2' + fields: + type: array + description: Unbounded list of individual field definitions. + minItems: 1 + items: + type: object + properties: + sectionKey: + $ref: '#/components/schemas/CustomDetailsSectionKeyv2' + label: + type: string + description: Human-readable name of the field. + example: Manufacturer Name + order: + type: string + description: Display order for the field. + minLength: 1 + maxLength: 3 + example: "1" + tooltip: + type: + - string + - "null" + description: Tooltip text explaining the field. + example: The name of the manufacturer for the product + isRequired: + type: string + description: Returns the conditionality of the field + oneOf: + - title: "Yes" + const: "Y" + - title: "No" + const: "N" + - title: "Conditional" + description: "If returned there will be at least one requirement condition" + const: "C" + requirementConditions: + type: + - array + - "null" + description: Unbounded array of rules. Conditionally required when is 'isRequired' flag is set. + items: + type: object + description: | + An object containing the specifics of each rule. Order is to be applied + top-down (OR conditions align with the prior rule). + properties: + logicalOperator: + type: string + description: | + Determines how the rules are joined when evaluating the condition if there are multiple rules. + Required for all rules except the first. + enum: + - "AND" + - "OR" + fieldKey: + type: + - string + - "null" + description: The key for the field that this rule is evaluating + example: IN001 + operator: + type: + - string + - "null" + description: The operator used when evaluating the rule + oneOf: + - title: Equals + const: "=" + - title: Greater Than + const: ">" + - title: Less Than + const: "<" + - title: Not Equal To + const: "!=" + value: + type: + - string + - "null" + description: The value used when evaluating the rule + example: CSB V + additionalProperties: false + required: + - fieldKey + - operator + - value + fieldType: + type: string + description: The type of the field, based on available html form inputs + enum: + - textbox + - list + - date + - radio + - checkbox + - textarea + example: textbox + allowedValueCount: + type: integer + description: Number of occurnces allowed for this field + minLength: 1 + maxLength: 2 + default: 1 + example: 1 + validation: + type: object + description: rule validation object + properties: + minLength: + type: + - integer + - "null" + description: The min length allowed for text fields + minLength: 1 + maxLength: 2 + minimum: 1 + maximum: 99 + example: 1 + maxLength: + type: + - integer + - "null" + description: The max length allowed for text fields + minLength: 1 + maxLength: 3 + minimum: 1 + maximum: 100 + example: 10 + errorMessage: + type: + - string + - "null" + description: Error Message + example: Enter a valid alpha numeric value. + dataType: + type: string + description: defines which type of values to look for + oneOf: + - title: Custom + description: user will be required to enter a custom regex pattern + const: Custom + - title: List + description: listValues will need to be populated with a list of possible values for the field + const: List + - title: Email + const: Email + - title: Text + const: Text + - title: Alphanumeric + const: Alphanumeric + - title: Number + const: Number + - title: Date + const: Date + regexPattern: + type: + - string + - "null" + description: | + A regex-based validation pattern for the field which should be applied when validating, + Required when the type is 'custom'. + example: ^[a-zA-Z0-9]+$ + listValues: + type: array + description: Unbounded list of string values to validate against. Required for type 'List' + items: + type: object + description: value to validate against + properties: + displayText: + type: string + description: Value to display in the dropdown for consumers + examples: + - GSTIN (Normal) + - GSTIN (Govt Entities) + - GSTIN (Diplomats) + - PAN Number + - TAN Number + - Passport Number + - Aadhaar Number + - Voter Id + internalValue: + type: string + description: Internal value for each dropdown item that is hidden to consumers + examples: + - GSTIN + - GSTINGE + - GSTIND + - PANNO + - TANNO + - PASSNO + - AADHAARNO + - VID + additionalProperties: false + required: + - displayText + - internalValue + additionalProperties: false + required: + - minLength + - maxLength + - errorMessage + - dataType + regulationSections: + $ref: '#/components/schemas/CustomDetailsRegulationSectionv2' + keyAlias: + type: + - string + - "null" + description: Alias used to identify the field when mapping to downstream systems. + example: ManufacturerName + level: + type: + - string + - "null" + description: Indicates whether the field applies at the shipment or product level. + enum: + - Shipment + - Product + example: Product + additionalProperties: false + required: + - order + - sectionKey + - label + - tooltip + - isRequired + - fieldType + - allowedValueCount + - validation + - regulationSections + additionalProperties: false + additionalProperties: false + required: + - countryCode + - shipmentType + - groupKey + - details + - regulation + - regulationSections + - fields + additionalProperties: false + required: + - commodityCodes + + #COMMON + CustomDetailsCommodityCodev2: + type: string + description: The tariff code for the product for the selected import country and process type + minLength: 1 + maxLength: 15 + example: "300490" + CustomDetailsGroupKeyv2: + type: string + description: Field group key returned by the GET endpoint used to scope the shipment metadata payload. + minLength: 1 + maxLength: 50 + example: US-IMP-CDC + CustomDetailsRequestMetaDatav2: + type: array + description: Unbounded list of containers for product metadata groups + minItems: 1 + items: + type: object + properties: + groupKey: + $ref: '#/components/schemas/CustomDetailsGroupKeyv2' + fields: + type: array + description: Unbounded list of key-value pairs describing product fields + minItems: 1 + items: + type: object + properties: + fieldKey: + type: string + description: Identifier for the field. + minLength: 1 + maxLength: 50 + examples: + - ImportLicenseNumber + - CSBType + - IECCode + - Amount + - CurrencyCode + - MnuNa + - MnuAdLn1Te + - MnuAdLn2Te + - MnuAdLn3Te + - MnuCtyNa + - MnuStPrvCd + - MnuCtyCd + - MnuPslCd + regulationSections: + $ref: '#/components/schemas/CustomDetailsRegulationSectionv2' + fieldValue: + type: string + description: Value of the field + minLength: 0 + maxLength: 500 + example: UPS Labs + additionalProperties: false + required: + - fieldKey + - fieldValue + additionalProperties: false + required: + - fields + CustomDetailsSectionKeyv2: + type: string + description: Identifier for the field. + minLength: 1 + maxLength: 50 + examples: + - Bio + - CSB + - Cos + - Dev + - Foo + CustomDetailsRegulationv2: + type: string + description: Identifier for the compliance Regulation. + minLength: 1 + maxLength: 50 + example: FDA + CustomDetailsRegulationSectionv2: + type: array + description: Unbounded list of regulationSection definitions for this Regulation. + minItems: 1 + items: + type: object + properties: + sectionKey: + description: Identifier for the field. Conditionaly required when sectionName is not present. + $ref: '#/components/schemas/CustomDetailsSectionKeyv2' + sectionName: + type: string + description: Human-readable regulationSection label. Conditionally required when sectionKey is not present. + minLength: 1 + maxLength: 100 + example: Cosmetics + additionalProperties: false + CustomDetailsErrorResponsev2: + type: object + description: Response object for errors + properties: + response: + description: Response container to store errors + type: object + properties: + errors: + type: array + description: Unbounded array containing one or more errors + items: + type: object + description: Error entity + properties: + code: + type: string + description: code for the given message + minLength: 1 + example: "105.002" + message: + type: string + description: the warning or error message to be conveyed + minLength: 1 + example: Supplied Key was not in the correct range. + description: + type: + - string + - "null" + description: Internal description of the error + minLength: 1 + example: INVALID_KEY + field: + type: + - string + - "null" + description: The path to the field causing the error as returned from the backend services. + minLength: 1 + example: shipperNumber + value: + type: + - string + - "null" + description: The value that caused the error + minLength: 1 + example: "789999" + additionalProperties: false + required: + - code + - message + required: + - errors + additionalProperties: false + required: + - response + additionalProperties: false \ No newline at end of file From 9dd95cac3b068e9223a28c856ac2d5b708117cee Mon Sep 17 00:00:00 2001 From: RohiniA-DevPortal Date: Wed, 11 Feb 2026 14:37:27 -0500 Subject: [PATCH 74/89] Update CustomsDetailV2.yaml --- CustomsDetailV2.yaml | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/CustomsDetailV2.yaml b/CustomsDetailV2.yaml index 8802908..f157a4f 100644 --- a/CustomsDetailV2.yaml +++ b/CustomsDetailV2.yaml @@ -1,32 +1,28 @@ openapi: 3.1.0 info: - title: UGC Customs Detail API v2 + title: Customs Detail API v2 version: "1.0" - description: > - Informs clients of the latest compliance needs for fields to be collected at the creation of UPS Brokerage shipments. - This API can then validate the values for these fields and accept them for merging to a shipment in the backend. + description: | - **Key Business Values:** - - keeps clients updated with latest compliance needs - - field data collection can be handled through user configuration - - the flexible framework removes the need for additional code changes as fields change + # Product Info + Provides clients with up‑to‑date compliance requirements for data fields that must be captured for UPS shipments. The API then validates these field values and submits them for backend merging into the shipment. For more information on the Customs Detail API, please visit the Product Info page.

+ + # Key Business Values + - Ensures clients always receive the latest compliance requirements. + - Allows field collection to be fully managed through configurable user settings. + - Flexible framework eliminates additional code changes as compliance fields evolve. + - Flexible field model supports new country rules without disruptive changes, so you can expand lanes and stay current as regulations evolve. servers: - - url: https://www.livesite.ups.com/trade/compliance/{version} - description: URL for JWT based authentication that can be used for any environment (production, staging, product test) via hosts file. - variables: - version: - default: v2 - enum: - - v2 - url: https://onlinetools.ups.com/api/trade/compliance/{version} - description: URL for Oauth based authentication that can be used for any environment (production, staging, product test) via hosts file. + description: Production variables: version: default: v2 enum: - v2 - url: https://wwwcie.ups.com/api/trade/compliance/{version} - description: UPS Production CIE + description: Customer Integration Environment variables: version: default: v2 @@ -38,7 +34,7 @@ tags: paths: /content/fields/customs-detail: post: - summary: validate and/or submit the fields + summary: Validate and/or submit the fields description: This endpoint will provide the ability to validate and/or submit the additional field information for a shipment parameters: - $ref: "#/components/parameters/transId" @@ -208,7 +204,7 @@ paths: "500": $ref: '#/components/responses/ServerError' get: - summary: returns required custom details + summary: Returns required custom details description: This returns an array of fields that are required for the provided import and/or export country parameters: - $ref: "#/components/parameters/transId" @@ -1249,4 +1245,4 @@ components: additionalProperties: false required: - response - additionalProperties: false \ No newline at end of file + additionalProperties: false From 972eef06156524e96c44d2a763e76680550b4f00 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:52:50 -0500 Subject: [PATCH 75/89] Update UPSTrackAlert.yaml --- UPSTrackAlert.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/UPSTrackAlert.yaml b/UPSTrackAlert.yaml index fadf07f..314fc8e 100644 --- a/UPSTrackAlert.yaml +++ b/UPSTrackAlert.yaml @@ -159,7 +159,7 @@ paths: - List of valid tracking number for which subscription created. - List of invalid tracking number for which subscription not created. tags: - - UPS Track Alert + - UPS Track Alert API summary: API to create subscriptions by tracking numbers. operationId: processSubscriptionTypeForTrackingNumber security: @@ -280,7 +280,7 @@ webhooks: summary: Tracking Event description: This HTTPS POST request will send information about a new tracking event in the system. Please ensure the webhook URL provided in the subscription request is ready to receive this POST request. Note that not every field will have a value in each message. The webhook event dispatched by our API requires an acknowledgement within milliseconds to ensure optimal performance and reliability. Please ensure your endpoint is capable of handling and responding to events in this time frame. tags: - - UPS Track Alert + - UPS Track Alert API parameters: - name: credential in: header @@ -728,3 +728,4 @@ components: type: string description: The current activity status description. + From 84de3baa85a5f96d771eb7e5e407019fa5c59dc1 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:53:47 -0500 Subject: [PATCH 76/89] Update DeliveryDefense.yaml --- DeliveryDefense.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/DeliveryDefense.yaml b/DeliveryDefense.yaml index 3e30f76..69b0878 100644 --- a/DeliveryDefense.yaml +++ b/DeliveryDefense.yaml @@ -20,7 +20,7 @@ info: The API is designed to enable customers to obtain an Address Confidence score based on analysis of historical data. version: "1.0" tags: - - name: Delivery Defense + - name: DeliveryDefense™ Address Confidence servers: - url: https://wwwcie.ups.com/api/deliverydefense/external/v1.0 description: DeliveryDefense Customer Integration Environment @@ -30,7 +30,7 @@ paths: /address/score: post: tags: - - Delivery Defense + - DeliveryDefense™ Address Confidence operationId: "score" summary: Get Verified Address Score description: | @@ -326,4 +326,5 @@ components: type: string description: >- Indicates if the address used for lookup is residential or - commercial \ No newline at end of file + + commercial From bf54030dc71afa9d6bb35998646240aa7d27bc31 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:54:56 -0500 Subject: [PATCH 77/89] Update DeliveryIntercept.yaml --- DeliveryIntercept.yaml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/DeliveryIntercept.yaml b/DeliveryIntercept.yaml index e53d695..3db5b5e 100644 --- a/DeliveryIntercept.yaml +++ b/DeliveryIntercept.yaml @@ -58,7 +58,7 @@ paths: description: Obtains intercept charges specified by the inquiry type and tracking number passed in the interface. operationId: getCharges tags: - - Delivery Intercept + - UPS Delivery Intercept security: - OAuth2: [] parameters: @@ -329,7 +329,7 @@ paths: description: Retrieves the delivery change eligibility information for the tracking number passed in the interface. operationId: getEligibilityOptions tags: - - Delivery Intercept + - UPS Delivery Intercept security: - OAuth2: [] parameters: @@ -482,7 +482,7 @@ paths: description: Submits a deliver to another address delivery change for the tracking number passed in the interface. operationId: getRedirectInterceptOptions tags: - - Delivery Intercept + - UPS Delivery Intercept security: - OAuth2: [] parameters: @@ -633,7 +633,7 @@ paths: description: Request your package to be held at or returned to a UPS facility where the receiver may claim the same-day. operationId: willcallInterceptOption tags: - - Delivery Intercept + - UPS Delivery Intercept security: - OAuth2: [] parameters: @@ -763,7 +763,7 @@ paths: description: Return a package to the original shipper prior to delivery. operationId: returnInterceptOption tags: - - Delivery Intercept + - UPS Delivery Intercept security: - OAuth2: [] parameters: @@ -894,7 +894,7 @@ paths: description: Have the package delivered to the original address but on a different day in the future. operationId: rescheduleInterceptOption tags: - - Delivery Intercept + - UPS Delivery Intercept security: - OAuth2: [] parameters: @@ -1025,7 +1025,7 @@ paths: description: Cancel a previously applied intercept on the package. operationId: cancelInterceptOption tags: - - Delivery Intercept + - UPS Delivery Intercept security: - OAuth2: [] parameters: @@ -2232,4 +2232,5 @@ components: additionalProperties: false required: - errorCode - - errorMessage \ No newline at end of file + + - errorMessage From 2f6d3bc3b23dd76fe9abeaf141d95b905c034c05 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:55:19 -0500 Subject: [PATCH 78/89] Update UPSExportAssure.yaml --- UPSExportAssure.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/UPSExportAssure.yaml b/UPSExportAssure.yaml index f2c9edc..1ed93d9 100644 --- a/UPSExportAssure.yaml +++ b/UPSExportAssure.yaml @@ -76,7 +76,7 @@ paths: post: operationId: submitExportAssure tags: - - Export Assure + - UPS® Export Assure Commodity Compliance Guidance summary: Submit shipment details for compliance guidance parameters: - $ref: '#/components/parameters/AccountNumber' @@ -2025,4 +2025,5 @@ components: perfStats: absLayerTime: "2322" fulfillTime: Tue Mar 19 12:29:16.523 -04:00 2024 - receiptTime: Tue Mar 19 12:29:14.201 -04:00 2024 \ No newline at end of file + + receiptTime: Tue Mar 19 12:29:14.201 -04:00 2024 From 648bef22bb615d0961f8f39137dbe4a015d750e2 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:56:02 -0500 Subject: [PATCH 79/89] Update InteractiveDescriptionGuidance.yaml --- InteractiveDescriptionGuidance.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/InteractiveDescriptionGuidance.yaml b/InteractiveDescriptionGuidance.yaml index f633581..71b7df2 100644 --- a/InteractiveDescriptionGuidance.yaml +++ b/InteractiveDescriptionGuidance.yaml @@ -37,7 +37,7 @@ servers: security: - OAuth2: [] tags: - - name: Interactive Description + - name: UPS® Export Assure Interactive Description of Goods description: Operations for interactively generating detailed product descriptions and HTC codes. - name: Feedback description: Operations for providing feedback using the 'id' of a question. @@ -45,7 +45,7 @@ paths: /interactive: post: tags: - - Interactive Description + - UPS® Export Assure Interactive Description of Goods summary: Initiates an interactive description session for a product. description: Initiates an interactive description session for a product. security: @@ -255,7 +255,7 @@ paths: /interactive/{sessionId}: post: tags: - - Interactive Description + - UPS® Export Assure Interactive Description of Goods summary: Continues refinement of product description and HTS code via questions and answers. description: | This endpoint facilitates the ongoing interactive process for refining a product description and determining its corresponding Harmonized Tariff Schedule (HTS) code. @@ -454,7 +454,7 @@ paths: /interactive/feedback/{sessionId}: post: tags: - - Interactive Description + - UPS® Export Assure Interactive Description of Goods summary: Allows the user to provide feedback on a specific question of the overall session. description: Allows the user to provide feedback on a specific question of the @@ -892,4 +892,5 @@ components: clientCredentials: x-tokenEndpointAuthMethod: client_secret_basic tokenUrl: https://wwwcie.ups.com/security/v1/oauth/token - scopes: {} \ No newline at end of file + + scopes: {} From 06ecbe621645be415765297a607bc87d50b58658 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:56:23 -0500 Subject: [PATCH 80/89] Update GlobalCheckout.yaml --- GlobalCheckout.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/GlobalCheckout.yaml b/GlobalCheckout.yaml index effbdaa..77cd121 100644 --- a/GlobalCheckout.yaml +++ b/GlobalCheckout.yaml @@ -33,7 +33,7 @@ servers: enum: - v1 tags: - - name: Global Checkout + - name: UPS® Global Checkout description: Operations related to guaranteed rate quotes security: - OAuth2: [] @@ -46,7 +46,7 @@ paths: security: - OAuth2: [] tags: - - Global Checkout + - UPS® Global Checkout parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -722,4 +722,5 @@ components: type: string description: The path to the field causing the error as returned from the backend services. example: shipment.importCountryCode - \ No newline at end of file + + From 8718835ad16f0b2e0bd58a4069e49f3122351b0b Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:56:38 -0500 Subject: [PATCH 81/89] Update LandedCost.yaml --- LandedCost.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/LandedCost.yaml b/LandedCost.yaml index ee04f16..ee6353b 100644 --- a/LandedCost.yaml +++ b/LandedCost.yaml @@ -35,7 +35,7 @@ paths: post: summary: Landed Cost Quote API tags: - - Landed Cost + - Estimated Landed Cost Quoting security: - OAuth2: [] description: The Landed Cost Quote API allows you to estimate the all-inclusive @@ -662,3 +662,4 @@ components: type: string description: The error message. description: The error response containing any errors that occurred. + From 57f87b1c4dabf0cae2d14401a0c2c0e9c42c6599 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:58:23 -0500 Subject: [PATCH 82/89] Update OAuthAuthCode.yaml --- OAuthAuthCode.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/OAuthAuthCode.yaml b/OAuthAuthCode.yaml index 51bb775..aa3391c 100644 --- a/OAuthAuthCode.yaml +++ b/OAuthAuthCode.yaml @@ -49,7 +49,7 @@ paths: - url: https://onlinetools.ups.com/security description: Production tags: - - OAuth Auth Code + - Authorization (OAuth) summary: Authorize Client description: |- The Authorize Client endpoint initiates the OAuth Authorization Code flow by redirecting the user to UPS for logging-in and authorize the client application. To begin the authorization flow, the application constructs a URL using the application's client Id, the redirect URI, the scope of permissions requested, and a random string used for subsequent verification. A successful response redirects back to the client with an authorization code that can be exchanged for an access token. @@ -414,3 +414,4 @@ components: description: Error message type: string + From 92e73a73839e79d8859c90471bf40118541e5bb1 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:58:54 -0500 Subject: [PATCH 83/89] Update Paperless.yaml --- Paperless.yaml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Paperless.yaml b/Paperless.yaml index 1acfad3..da2358c 100644 --- a/Paperless.yaml +++ b/Paperless.yaml @@ -28,7 +28,7 @@ paths: post: summary: Upload Paperless Document tags: - - Paperless + - Paperless Documents security: - OAuth2: [] description: 'The Paperless Document API web service allows the users to upload,delete @@ -150,7 +150,7 @@ paths: post: summary: Paperless Document Push Image tags: - - Paperless + - Paperless Documents security: - OAuth2: [] description: 'The Paperless Document API web service allows the users to upload @@ -245,7 +245,7 @@ paths: delete: summary: Delete Paperless Document tags: - - Paperless + - Paperless Documents security: - OAuth2: [] description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. @@ -322,7 +322,7 @@ paths: deprecated: true summary: Upload Paperless Document tags: - - Paperless + - Paperless Documents security: - OAuth2: [] description: 'The Paperless Document API web service allows the users to upload,delete @@ -445,7 +445,7 @@ paths: deprecated: true summary: Paperless Document Push Image tags: - - Paperless + - Paperless Documents security: - OAuth2: [] description: 'The Paperless Document API web service allows the users to upload @@ -541,7 +541,7 @@ paths: deprecated: true summary: Delete Paperless Document tags: - - Paperless + - Paperless Documents security: - OAuth2: [] description: The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History. @@ -1156,3 +1156,4 @@ components: type: string description: The error message. description: The error response containing any errors that occurred. + From 018e5968b2be9af7200ef80a77a29c986cec666d Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:59:17 -0500 Subject: [PATCH 84/89] Update PreNotification.yaml --- PreNotification.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/PreNotification.yaml b/PreNotification.yaml index 93d7a5e..94a6178 100644 --- a/PreNotification.yaml +++ b/PreNotification.yaml @@ -28,7 +28,7 @@ paths: post: summary: Pre-Notification tags: - - Pre-Notification + - Pre Notification security: - OAuth2: [] description: The Pre-Notification API allows customer applications to inform @@ -171,7 +171,7 @@ paths: deprecated: true summary: Pre-Notification tags: - - Pre-Notification + - Pre Notification security: - OAuth2: [] description: The Pre-Notification API allows customer applications to inform @@ -900,3 +900,4 @@ components: type: string description: The error message. description: The error response containing any errors that occurred. + From f86f8e65349e734d0b82a2bfa65af2ac6bdda9f7 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 14:59:41 -0500 Subject: [PATCH 85/89] Update TradeDirect.yaml --- TradeDirect.yaml | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/TradeDirect.yaml b/TradeDirect.yaml index e0d45a0..3748da8 100644 --- a/TradeDirect.yaml +++ b/TradeDirect.yaml @@ -26,7 +26,7 @@ paths: /master-shipments/{usi-number}: delete: tags: - - TradeDirect + - UPS TradeDirect summary: Delete master shipment description: "This API allows users to delete a master shipment identified by a unique shipment identifier (USI) and the shipper's account number. The master shipment and its associated child shipments will be permanently removed." operationId: deleteMasterShipment @@ -188,7 +188,7 @@ paths: /master-shipments/{usi-number}/child-shipments/{tracking-number}: delete: tags: - - TradeDirect + - UPS TradeDirect summary: Delete small package shipment description: "Deletes a small package child shipment identified by a unique shipment identifier (USI) representing the master shipment and the shipment's tracking number." operationId: deleteChildShipment @@ -348,7 +348,7 @@ paths: /master-shipments/{usi-number}/closeout: post: tags: - - TradeDirect + - UPS TradeDirect operationId: closeoutMasterShipment summary: Closeout a Master Shipment description: Transitions a master shipment to a closed state, finalizing its processing. Identified by a unique shipment identifier (USI). @@ -607,7 +607,7 @@ paths: /master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}: delete: tags: - - TradeDirect + - UPS TradeDirect operationId: deleteLtlChildShipment summary: Delete Less Than Truckload (LTL) child shipment description: "Deletes a Less Than Truckload (LTL) child shipment identified by a unique shipment identifier (USI) and a sub pro number." @@ -766,7 +766,7 @@ paths: /master-shipments/documents: post: tags: - - TradeDirect + - UPS TradeDirect operationId: documentLabelPlayback summary: Genereate Documents and Labels for LTL Shipments and Closeout description: "Generates documents and labels for master/ltl shipments identified by a unique shipment identifier (USI)." @@ -1452,4 +1452,5 @@ components: tokenUrl: https://onlinetools.ups.com/security/v1/oauth/token scopes: { } security: - - oauth2: [] \ No newline at end of file + + - oauth2: [] From e96d5cc587effa3827a46e6ec20a083e3b7d87b9 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 15:00:13 -0500 Subject: [PATCH 86/89] Update WorldEaseShipmentManagement.yaml --- WorldEaseShipmentManagement.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/WorldEaseShipmentManagement.yaml b/WorldEaseShipmentManagement.yaml index 3a68c31..4e32397 100644 --- a/WorldEaseShipmentManagement.yaml +++ b/WorldEaseShipmentManagement.yaml @@ -32,7 +32,7 @@ paths: /master-shipment/closeout/{shipment-gccn}: post: tags: - - World Ease Shipment Management - Shipment + - World Ease Shipment Management operationId: saveCloseOutShipment summary: Close Out Shipment description: | @@ -143,7 +143,7 @@ paths: /master-shipment/{shipment-gccn}: delete: tags: - - World Ease Shipment Management - Shipment + - World Ease Shipment Management operationId: "deleteMasterShipment" summary: "Deletes the master shipment" description: " Deletes the specified master shipment from the system. Once deleted system cannot be recovered" @@ -247,7 +247,7 @@ paths: /child-shipment/{shipment-gccn}/{tracking-number}: delete: tags: - - World Ease Shipment Management - Shipment + - World Ease Shipment Management operationId: "deleteChildShipment" summary: "Delete the child shipment " description: " This is used to delete the child shipment record from the database" @@ -456,3 +456,4 @@ components: maxLength: 512 example: SAM + From fef3dab7e20c63e7a7bbddcb4891a1c6edfa700d Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 15:04:04 -0500 Subject: [PATCH 87/89] Update TradeDirect.yaml --- TradeDirect.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/TradeDirect.yaml b/TradeDirect.yaml index 3748da8..aabc365 100644 --- a/TradeDirect.yaml +++ b/TradeDirect.yaml @@ -26,7 +26,7 @@ paths: /master-shipments/{usi-number}: delete: tags: - - UPS TradeDirect + - UPS TradeDirect summary: Delete master shipment description: "This API allows users to delete a master shipment identified by a unique shipment identifier (USI) and the shipper's account number. The master shipment and its associated child shipments will be permanently removed." operationId: deleteMasterShipment @@ -188,7 +188,7 @@ paths: /master-shipments/{usi-number}/child-shipments/{tracking-number}: delete: tags: - - UPS TradeDirect + - UPS TradeDirect summary: Delete small package shipment description: "Deletes a small package child shipment identified by a unique shipment identifier (USI) representing the master shipment and the shipment's tracking number." operationId: deleteChildShipment @@ -348,7 +348,7 @@ paths: /master-shipments/{usi-number}/closeout: post: tags: - - UPS TradeDirect + - UPS TradeDirect operationId: closeoutMasterShipment summary: Closeout a Master Shipment description: Transitions a master shipment to a closed state, finalizing its processing. Identified by a unique shipment identifier (USI). @@ -607,7 +607,7 @@ paths: /master-shipments/{usi-number}/ltl-child-shipments/{sub-pro-number}: delete: tags: - - UPS TradeDirect + - UPS TradeDirect operationId: deleteLtlChildShipment summary: Delete Less Than Truckload (LTL) child shipment description: "Deletes a Less Than Truckload (LTL) child shipment identified by a unique shipment identifier (USI) and a sub pro number." @@ -766,7 +766,7 @@ paths: /master-shipments/documents: post: tags: - - UPS TradeDirect + - UPS TradeDirect operationId: documentLabelPlayback summary: Genereate Documents and Labels for LTL Shipments and Closeout description: "Generates documents and labels for master/ltl shipments identified by a unique shipment identifier (USI)." @@ -1454,3 +1454,4 @@ components: security: - oauth2: [] + From 4c03bea4dbbc74d90a26292424139e4e8df97561 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Thu, 12 Feb 2026 15:04:36 -0500 Subject: [PATCH 88/89] Update GlobalCheckout.yaml --- GlobalCheckout.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/GlobalCheckout.yaml b/GlobalCheckout.yaml index 77cd121..8f26ef6 100644 --- a/GlobalCheckout.yaml +++ b/GlobalCheckout.yaml @@ -46,7 +46,7 @@ paths: security: - OAuth2: [] tags: - - UPS® Global Checkout + - UPS® Global Checkout parameters: - $ref: "#/components/parameters/transId" - $ref: "#/components/parameters/transactionSrc" @@ -724,3 +724,4 @@ components: example: shipment.importCountryCode + From e4c937d5b27f959afa32cca1b6249bacfde304e6 Mon Sep 17 00:00:00 2001 From: UPSCadeCreech <103506895+UPSCadeCreech@users.noreply.github.com> Date: Tue, 10 Mar 2026 11:57:26 -0400 Subject: [PATCH 89/89] Update OAuthAuthCode.yaml --- OAuthAuthCode.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/OAuthAuthCode.yaml b/OAuthAuthCode.yaml index aa3391c..4362bae 100644 --- a/OAuthAuthCode.yaml +++ b/OAuthAuthCode.yaml @@ -150,7 +150,7 @@ paths: - url: https://onlinetools.ups.com/security description: Production tags: - - OAuth Auth Code + - Authorization (OAuth) security: - BasicAuthGenerate: [] description: The Generate Token endpoint exchanges the authorization code received @@ -229,7 +229,7 @@ paths: - BasicAuthRefresh: [] summary: Refresh Token tags: - - OAuth Auth Code + - Authorization (OAuth) operationId: RefreshToken description: The /refresh endpoint is used to refresh an expired access token in order to continue accessing a UPS API on behalf of a user. The endpoint @@ -415,3 +415,4 @@ components: type: string +