# Dispatch

Informs   that the order has been dispatched.

> It is expected to receive a  event after this action.

 This endpoint should be sent .

HOST: 

DIRECTION:

  


Endpoint: POST /v1/orders/{orderId}/dispatch
Version: v.1.0.6
Security: OAuth2, Sig

## Path parameters:

  - `orderId` (string, required)
    The unique identifier of the order. The order ID is generated by  Keeta.

## Request fields (application/json):

  - `deliveryTrackingInfo` (object)
    Information about the person that was assigned to deliver the order.

  - `deliveryTrackingInfo.event` (object)
    The delivery last known event.

  - `deliveryTrackingInfo.event.type` (string, required)
    The current delivery event.
    Enum: "DELIVERY_ONGOING", "ARRIVED_AT_CUSTOMER", "ORDER_DELIVERED", "CANCELLED"

  - `deliveryTrackingInfo.event.message` (string)
    Free message. It should be used to provide more detailed information.

  - `deliveryTrackingInfo.event.datetime` (string, required)
    Date and time when the event ocurred. 

(UTC date-time in ISO timestamp format. See [Guidelines](#section/General-Guidelines) for more info).

  - `deliveryTrackingInfo.problem` (object)
    In the event of a delivery problem, it states the last known reason.

  - `deliveryTrackingInfo.problem.reason` (string, required)
    Problem reason.
    Enum: "DELIVERYPERSON_OCCURRENCE", "PAYMENT_PROBLEMS", "WRONG_PRODUCT_OR_ITEM", "ORDER_DELAYED", "ORDER_DAMAGED_OR_VIOLATED", "CUSTOMER_DID_NOT_PLACE_ORDER", "CUSTOMER_ADDRESS_UNKNOWN", "ORDER_MISSING_ITEMS", "NOBODY_TO_RECEIVE", "DELIVERYPERSON_WAITING_PAYMENT_FOR_ALREADY_PAID_ORDER", "ORDER_DELIVERED_WITHOUT_PAYMENT", "FRAUD_OR_THEFT"

  - `deliveryTrackingInfo.problem.datetime` (string, required)
    Date and time when the problem ocurred. 

(UTC date-time in ISO timestamp format. See [Guidelines](#section/General-Guidelines) for more info).

  - `deliveryTrackingInfo.vehicle` (object)
    The vehicle that will be used for this delivery.

  - `deliveryTrackingInfo.vehicle.type` (array, required)
    Vehicle Type
    Enum: "MOTORBIKE_BAG", "MOTORBIKE_BOX", "CAR", "BICYCLE", "SCOOTER", "VUC"

  - `deliveryTrackingInfo.vehicle.licencePlate` (string)
    Licence plate of the vehicle user for the delivery.

  - `deliveryTrackingInfo.eta` (object)
    Estimate Times of Pickup and Delivery.

  - `deliveryTrackingInfo.eta.deliveryEtaInMinutes` (integer)
    Delivery Eta in . Informs how many minutes it will take the delivery person to arrive at the consumer's address for order delivery.

  - `deliveryTrackingInfo.eta.deliveryEtaDatetime` (string)
    Delivery Eta Datetime. Informs the date and time the delivery person is expected to arrive at the consumer's address for order delivery. 

(UTC date-time in ISO timestamp format. See [Guidelines](#section/General-Guidelines) for more info).

  - `deliveryTrackingInfo.eta.maxDeliveryTime` (string)
    Maximum Date and Time for delivery. This time should not exceed the delivery time limit given in the order request. 

(UTC date-time in ISO timestamp format. See [Guidelines](#section/General-Guidelines) for more info).

  - `deliveryTrackingInfo.deliveryPerson` (object)
    Information about the person taht was assigned to deliver the order.

  - `deliveryTrackingInfo.deliveryPerson.id` (string)
    Delivery Person Id given by the .

  - `deliveryTrackingInfo.deliveryPerson.name` (string)
    Delivery Person Name.

  - `deliveryTrackingInfo.deliveryPerson.pictureURL` (string)
    URL to access the photo of the delivery person. Before entering this field, check that the parties allow data to be shared according to data disclosure laws and rules.

  - `deliveryTrackingInfo.deliveryPerson.areaCode` (string)
    Delivery Person telephone area code.
    Example: "+55"

  - `deliveryTrackingInfo.deliveryPerson.phone` (string)
    Delivery Person phone number.
    Example: "1234567"

  - `deliveryTrackingInfo.geoLocalization` (object)
    Geo Localization Info.

  - `deliveryTrackingInfo.geoLocalization.latitude` (number)
    Indicates the latitude coordinate of the actual position of the delivery person.



Latitude in degrees. Values are restricted to the range [[-90, 90]].
    Example: -23.54809

  - `deliveryTrackingInfo.geoLocalization.longitude` (number)
    Indicates the longitude coordinate of the actual position of the delivery person.



Longitude in degrees. Values are restricted to the range [[-180, 180]].
    Example: -46.63638

  - `deliveryTrackingInfo.geoLocalization.lastAddress` (object)
    The last known address that the delivery person was when the event was sent.

  - `deliveryTrackingInfo.geoLocalization.lastAddress.country` (string)
    Two-letter [ISO 3166-1 alpha-2](https://www.iso.org/standard/72482.html) country code.
    Example: "BR"

  - `deliveryTrackingInfo.geoLocalization.lastAddress.state` (string)
    State or country subdivision. It is recommended (but not required) that you use the [ISO 3166-2](https://www.iso.org/standard/72483.html) representation.
    Example: "BR-SP"

  - `deliveryTrackingInfo.geoLocalization.lastAddress.city` (string)
    City name.
    Example: "São Paulo"

  - `deliveryTrackingInfo.geoLocalization.lastAddress.district` (string)
    District or Neighborhood name.
    Example: "Moema"

  - `deliveryTrackingInfo.geoLocalization.lastAddress.street` (string)
    Street Name.
    Example: "Plaza Avenue"

  - `deliveryTrackingInfo.geoLocalization.lastAddress.postalCode` (string)
    Postal Code.
    Example: "20111-000"

  - `deliveryTrackingInfo.geoLocalization.lastAddress.distanceToPickup` (string, required)
    Distance To Pickup in .

  - `deliveryTrackingInfo.geoLocalization.lastAddress.distanceToDelivery` (string, required)
    Distance To Delivery in .

  - `deliveryTrackingInfo.geoLocalization.lastAddress.timestamp` (string, required)
    Date and time when this information is valid. 

(UTC date-time in ISO timestamp format. See [Guidelines](#section/General-Guidelines) for more info).

  - `deliveryTrackingInfo.externalTrackingURL` (string)
    External URL, provided by the logistics service to track the delivery on a specific page. Example: Real-time map view, or delivery timeline.

## Response 400 fields (application/problem+json):

  - `title` (string, required)
    Short description of the problem.
    Example: "Unexpected error"

  - `status` (integer, required)
    HTTP code of the returned status.
    Example: 500

## Response 401 fields (application/problem+json):

  - `title` (string, required)
    Short description of the problem.
    Example: "Unexpected error"

  - `status` (integer, required)
    HTTP code of the returned status.
    Example: 500

## Response 403 fields (application/problem+json):

  - `title` (string, required)
    Short description of the problem.
    Example: "Unexpected error"

  - `status` (integer, required)
    HTTP code of the returned status.
    Example: 500

## Response 404 fields (application/problem+json):

  - `title` (string, required)
    Short description of the problem.
    Example: "Unexpected error"

  - `status` (integer, required)
    HTTP code of the returned status.
    Example: 500

## Response 422 fields (application/problem+json):

  - `title` (string, required)
    Short description of the problem.
    Example: "Unexpected error"

  - `status` (integer, required)
    HTTP code of the returned status.
    Example: 500

## Response 503 fields (application/problem+json):

  - `title` (string, required)
    Short description of the problem.
    Example: "Unexpected error"

  - `status` (integer, required)
    HTTP code of the returned status.
    Example: 500