--- title: "Confirm a delivery window for order" method: POST path: "/v1/order/external-identifier/{externalId}/delivery-window/confirm" tags: ["Delivery Windows"] --- # Confirm a delivery window for order `POST /v1/order/external-identifier/{externalId}/delivery-window/confirm` ## Request - Base URL: `https://api.sandbox.usenash.com` - URL: `https://api.sandbox.usenash.com/v1/order/external-identifier/{externalId}/delivery-window/confirm` - Auth: none declared Confirm a previously booked delivery window for an order. Finalizes the booking and commits the capacity reservation. ## Path parameters - `externalId` string, required: The external id of the order to update ## Response `200` OK - OrderOutputExample - `id` string, required: The id of the order - `createdAt` string, date-time, required: The date and time when the order was created - `externalId` string, nullable: The external id of the order - `externalGroupId` string, nullable: The external group id of the order - `referenceId` string, nullable: A non-unique identifier for orders, visible to the courier if supported by the provider. - `portalUrl` string, required: The URL of the order in the Nash portal - `publicTrackingUrl` string, required: The URL of the order in the public tracking system - `status` string, required: The status of the order - `tags` string[], nullable, required: The tags of the order - `orderMetadata` object, nullable: Key-value data to attach to Nash Jobs. - `pickupAddress` string, nullable: The pickup address of the order - `pickupPlaceId` string, nullable: Google place id for the pickup location. - `pickupAddressNumber` string, nullable: The number on a house. - `pickupAddressSecondarynumber` string, nullable: Secondary number on an address e.g. an apartment building. - `pickupAddressFormattedStreet` string, nullable: The street of the address. - `pickupAddressCity` string, nullable: The city of the pickup address. - `pickupAddressCounty` string, nullable: The county associated with the pickup address. - `pickupAddressState` string, nullable: The state of the pickup address. - `pickupAddressZip` string, nullable: The zip or postal code of the pickup address. - `pickupAddressCountry` string, nullable: The ISO 3166-1 alpha-2 country code of the pickup address. - `pickupLat` number, nullable: The pickup latitude coordinate. - `pickupLng` number, nullable: The pickup longitude coordinate. - `pickupPhoneNumber` string, nullable: The phone number to contact at the pickup location in the form: '+15555555555' - `pickupEmail` string, nullable: The email of the contact at the pickup location. - `pickupFirstName` string, nullable: First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters. - `pickupLastName` string, nullable: Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters. - `pickupBusinessName` string, nullable: Pickup business name at the origin. - `pickupInstructions` string, nullable: Any special instructions for pickup. - `pickupStoreLocationId` string, nullable: A unique identifier for store location created in Nash. - `pickupExternalStoreLocationId` string, nullable: The external identifier used for your store. - `pickupZoneIds` string[], nullable: A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window. - `pickupBarcodes` string[], nullable: Array containing barcode values that are required to be scanned at the pickup waypoint. - `pickupPayment` PickupPayment - `barcode` PickupPaymentBarcode - `type` string, nullable: The barcode symbology (e.g. CODE128, QR). - `value` string, nullable: The barcode value the courier should present at pickup. - `providerCard` boolean, nullable: If true, the courier pays for the order at pickup using a provider-issued card. - `dropoffAddress` string, nullable: The dropoff address of the order - `dropoffPlaceId` string, nullable: Google place id for the dropoff location. - `dropoffAddressNumber` string, nullable: The number on a house. - `dropoffAddressSecondarynumber` string, nullable: Secondary number on an address e.g. an apartment building. - `dropoffAddressFormattedStreet` string, nullable: The street of the address. - `dropoffAddressCity` string, nullable: The city of the dropoff address. - `dropoffAddressCounty` string, nullable: The county associated with the dropoff address. - `dropoffAddressState` string, nullable: The state of the dropoff address. - `dropoffAddressZip` string, nullable: The zip or postal code of the dropoff address. - `dropoffAddressCountry` string, nullable: The ISO 3166-1 alpha-2 country code of the dropoff address. - `dropoffLat` number, nullable: The dropoff latitude coordinate. - `dropoffLng` number, nullable: The dropoff longitude coordinate. - `dropoffPhoneNumber` string, nullable: The phone number to contact at the dropoff location in the form: '+15555555555' - `dropoffEmail` string, nullable: The email of the contact at the dropoff location. - `dropoffFirstName` string, nullable: First name of the contact at the destination. - `dropoffLastName` string, nullable: Last name of the contact at the destination. - `dropoffBusinessName` string, nullable: Dropoff business name at the destination. - `dropoffInstructions` string, nullable: Any special instructions for dropoff. - `dropoffStoreLocationId` string, nullable: A unique identifier for store location created in Nash. - `dropoffBarcodes` string[], nullable: Array containing barcode values that are required to be scanned at the dropoff waypoint. - `deliveryMode` string, nullable: The delivery mode of the order - `pickupStartTime` string, nullable: The start time of the pickup window. - `pickupEndTime` string, nullable: The end time of the pickup window. - `dropoffStartTime` string, nullable: The start time of the dropoff window. - `dropoffEndTime` string, nullable: The end time of the dropoff window. - `description` string, nullable: The description of the order - `itemsCount` string, nullable: The number of items in the order - `requirements` string[], nullable: The requirements of the order - `minimumVehicleSize` 'any' | 'bike' | 'motorbike' | 'cargobike' | 'cargo_bike' | 'sedan' | 'car' | 'suv' | 'pickup_truck' | 'pickup' | 'van' | 'large_van' | 'extra_large_van' | 'truck', nullable: The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck'] - `currency` string, nullable: The currency of the order - `valueCents` string, nullable: The value of the order in cents - `tipAmountCents` string, nullable: The tip amount of the order in cents - `dueAmountCents` string, nullable: Cash the driver must collect from the recipient on delivery, in cents. Null when not specified. - `width` string, nullable: The width of the order in cm - `depth` string, nullable: The depth of the order in cm - `height` string, nullable: The height of the order in cm - `volume` string, nullable: The volume of the order in cm^3 - `weight` string, nullable: The weight of the order in kg - `items` ItemInput[], nullable: The items of the order - `id` string, nullable: The merchant ID of the item - `description` string, nullable: The description of the item - `count` integer, nullable: The quantity of the item - `dimensions` Dimensions - `height` union: The height of the item in centimeters (cm) - number - integer - `width` union: The width of the item in centimeters (cm) - number - integer - `depth` union: The depth of the item in centimeters (cm) - number - integer - `weight` union: The weight of the item in kilograms (kg) - number - integer - `valueCents` integer, nullable: The value of the item in cents - `requirements` string[], nullable: List of requirements for this item - `category` string, nullable: The category of the item - `barcode` string, nullable: Barcode value for this item. - `metadata` object, nullable: Key-value data to attach to this item. - `volume` union: The volume of the item in cubic centimeters (cm^3) - number - integer - `subItems` SubItemInput[], nullable: The nested sub-items - `id` string, nullable: The merchant ID of the item - `description` string, nullable: The description of the item - `count` integer, nullable: The quantity of the item - `dimensions` Dimensions - `height` union: The height of the item in centimeters (cm) - number - integer - `width` union: The width of the item in centimeters (cm) - number - integer - `depth` union: The depth of the item in centimeters (cm) - number - integer - `weight` union: The weight of the item in kilograms (kg) - number - integer - `valueCents` integer, nullable: The value of the item in cents - `requirements` string[], nullable: List of requirements for this item - `category` string, nullable: The category of the item - `barcode` string, nullable: Barcode value for this item. - `metadata` object, nullable: Key-value data to attach to this item. - `sku` string, nullable: The SKU of the sub-item - `substitution` SubstitutionObject - `preference` string, nullable: What to do when this item can't be picked: `refund`, `substitute`, or `contact` (the shopper contacts the customer to agree a substitution). - `source` string, nullable: Source of substitution, e.g., merchant, customer - `substituteItems` SubstituteItemObject[], nullable: List of substitute items - `id` string, nullable: The ID of the substitute item - `sku` string, nullable: The SKU of the substitute item - `quantity` integer, nullable: The quantity of the substitute item - `subItems` SubItemInput[], nullable: The nested sub-items - `dispatchStrategyId` string, nullable: The dispatch strategy id (or option group id) to be associated with the order. Note: It is the best practice to allow automations to control dispatch strategy and not send the dispatch strategy id in the request. - `maxDeliveryFeeCents` string, nullable: The max delivery fee of the order in cents - `documents` OrderDocumentOutput[], nullable: The documents of the order - `createdAt` string, date-time, required: The date and time when the document was created - `id` string, required: The id of the document - `type` 'shipping_label' | 'pickup_label' | 'manifest' | 'packing_slip_label' | 'proof_of_delivery', required - `contentType` string, required: The content type of the document - `url` string, nullable: The URL of the document - `data` string, nullable: The document content when load_data=true: text documents such as ZPL as plain text, all others such as PDF as base64 - `validationErrors` object, nullable: The validation errors of the order - `quotes` QuoteSerializer[], nullable: The quotes of the order - `id` string, required: Quote ID - `type` string, nullable: Quote type - `providerId` string, required: Provider ID - `providerName` string, required: Provider name - `providerLogo` string, nullable: Provider logo - `providerIsInternal` boolean, nullable: Is the provider internal - `createdTime` string, required: Created time - `expireTime` string, nullable: Expire time - `priceCents` integer, required: Price in cents - `taxAmountCents` integer, nullable: Tax amount in cents - `tollFeeCents` integer, nullable: Toll fee in cents - `nashFeeCents` integer, nullable: Nash fee in cents - `insuranceFeeCents` integer, nullable: Insurance fee in cents - `currency` string, nullable: Currency - `pickupWindow` string, nullable: Pickup window - `dropoffEta` string, nullable: Dropoff ETA - `tags` string[], nullable: Tags - `costSplitCustomerCents` integer, nullable: Cost split customer in cents - `costSplitBusinessCents` integer, nullable: Cost split business in cents - `totalPriceBreakdown` object, nullable: Total price breakdown - `totalPriceCents` integer, nullable: Total price in cents - `rank` integer, nullable: Quote rank for preferred provider ordering - `price` number, nullable: Price - `isSuccessful` boolean, nullable: Is successful - `errorMessage` string, nullable: Error message - `errorCode` string, nullable: Machine-readable quote failure code - `errorDetails` object, nullable: Structured quote failure details - `failedQuotes` string[], nullable: The failed quotes of the order - `quoteFailure` object, nullable: Summary when every provider rejects the package requirements ## Other responses - `422`: Unprocessable Content --- [API](https://skmtc.dev/nash/apis/nash-api.md) - [All operations](https://skmtc.dev/nash/apis/nash-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nash/apis/nash-api/revisions/e3713837c5c9?raw)