Calculate Delivery Capacity

Calcula la capacidad de entrega, soportando agrupación de ítems por origen y permitiendo diferentes tipos de despacho y destinos para los grupos de ítems.

Request Body

purchaseDatestring

Purchase date in ISO 8601 format

Formatdate

isLastRoute?boolean

Indicates if this is the last route

dispatchType?string

Type of dispatch: NORMAL, EXPRESS

Value in"NORMAL" | "EXPRESS"

dispatchMode?string

Type of dispatch: HOME_DELIVERY, STORE_WITHDRAWAL, ALL_DISPATCH_MODES

Value in"HOME_DELIVERY" | "STORE_WITHDRAWAL" | "ALL_DISPATCH_MODES"

saleChannelstring

Sale channel for the delivery

entitySale?string

Entity code of the entity making the sale

hasFreightAttributeConfiguration?boolean

Indicates if the delivery has freight attribute configuration

Defaultfalse

calculationOptions?

deliveryData

items

Response Body

application/json

curl -X POST "https://loading/https/api/business-irdgco-delivery/v1/delivery/capacity" \
  -H "Content-Type: application/json" \
  -d '{
    "purchaseDate": "2019-08-24",
    "saleChannel": "string",
    "deliveryData": {},
    "items": [
      {}
    ]
  }'

curl -X POST "https://loading/https/api/business-irdgco-delivery/v1/delivery/capacity" \  -H "Content-Type: application/json" \  -d '{    "purchaseDate": "2019-08-24",    "saleChannel": "string",    "deliveryData": {},    "items": [      {}    ]  }'

{
  "logisticsCapacity": [
    {
      "origin": "string",
      "destination": "string",
      "dispatchType": "string",
      "dispatchCode": "string",
      "deliveryCost": 0.1,
      "zone": "string",
      "pickingDays": [
        "LUN"
      ],
      "processingDays": 0,
      "leadTimes": [
        0
      ],
      "routeDaysOfWeek": [
        [
          "string"
        ]
      ],
      "route": "string",
      "pickingDate": "string",
      "deliveryDates": [
        [
          "2023-10-25"
        ]
      ],
      "originEntityDetails": {
        "entityType": "string",
        "entityCode": "string",
        "name": "string",
        "shortName": "string",
        "vtexWarehouseId": "string",
        "vtexDockId": "string",
        "contactNumber": "string",
        "addressInfo": {
          "address": "string",
          "district": "string",
          "province": "string",
          "ubigeoCode": "string",
          "country": "string",
          "latitude": 0.1,
          "longitude": 0.1
        }
      },
      "pickupEntityDetails": {
        "entityType": "string",
        "entityCode": "string",
        "name": "string",
        "shortName": "string",
        "vtexWarehouseId": "string",
        "vtexDockId": "string",
        "contactNumber": "string",
        "addressInfo": {
          "address": "string",
          "district": "string",
          "province": "string",
          "ubigeoCode": "string",
          "country": "string",
          "latitude": 0.1,
          "longitude": 0.1
        }
      },
      "deliveryTrace": [
        {
          "deliveryDate": "string",
          "shippingEstimate": 0,
          "details": [
            {
              "sourceNode": "string",
              "targetNode": "string",
              "route": "string",
              "usedDispatchCapacity": 0,
              "usedPickingCapacity": 0,
              "dispatchDate": "string",
              "dispatchUnits": 0,
              "leadTime": 0,
              "daysOfWeek": "string",
              "departureDate": "string",
              "receptionDate": "string"
            }
          ],
          "deliveryWindows": [
            {
              "deliveryWindow": "string",
              "deliveryWindowStart": "string",
              "deliveryWindowEnd": "string",
              "blocked": true
            }
          ]
        }
      ],
      "arriveDates": [
        {
          "node": "string",
          "arriveDate": "string"
        }
      ],
      "message": "string",
      "detailedCapacityError": [
        {
          "code": "STOCK_ERROR",
          "details": [
            {
              "errorCode": "SOLD_OUT_QUANTITY",
              "description": "string",
              "sku": "string",
              "requestedQuantity": 0.1,
              "availableQuantity": 0.1
            }
          ],
          "providerDetails": {
            "code": "string",
            "message": "string",
            "detail": "string",
            "detailCapacity": [
              {
                "message": "string"
              }
            ],
            "detailStock": [
              {
                "sku": "string",
                "requestedQuantity": 0.1,
                "availableQuantity": 0.1,
                "warningMessage": "string"
              }
            ]
          }
        }
      ],
      "dispatchItems": [
        {
          "skuCode": "string",
          "origin": "string",
          "companyCode": "string",
          "line": "string",
          "quantity": 0.1,
          "weight": 0.1,
          "presentationCode": "string",
          "division": "string",
          "units": 0,
          "measurable": "string",
          "attributes": [
            {
              "attribute": "string",
              "attributeValue": "string",
              "attributeCode": "string"
            }
          ]
        }
      ]
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": {}
}

Calculate Delivery Capacity

Request Body

Response Body

200application/json

400application/json

application/json

application/json