delivery-packages

Library of functions that help to separate items in parcels and select delivery items on UIs

Motivation

The UX of displaying to the user how their items are going to be delivered can be tricky to be expressed and developed.

There are many criteria to split items in different parcels. They are:

1. Seller
2. SLAs options
3. Selected SLA ID
4. Selected SLA Shipping Estimate
5. Selected SLA Delivery Channel
6. Packages already delivered (post purchase scenario)
7. Group SLAs based on having a valid availableDeliveryWindows
8. Selected SLA Type, distinguishing pickup from pickup checked in (take away)

This module provides a consistent way to handle all those criteria.

And provide also helper functions for other use cases.

Install

$ npm install @vtex/delivery-packages

API

• parcelify

Address

• addAddressId
• addPickupPointAddresses
• findAddressIndex
• findAddress
• findAddressByPostalCode
• isAddressComplete
• isPickupAddress
• isDeliveryAddress
• getDeliveryAvailableAddresses
• groupByAddressType
• addOrReplaceAddressTypeOnList
• addOrReplaceAddressOnList
• setDeliveryAddressOnList

Delivery Channel

• getDeliveryChannel
• isPickup
• isDelivery
• findChannelById

Items

• getNewItems
• getDeliveredItems
• getItemsIndexes

Scheduled Delivery

• areAvailableDeliveryWindowsEquals
• selectDeliveryWindow
• getFirstScheduledDelivery

Shipping

• getNewLogisticsInfo
• getNewLogisticsInfoWithSelectedScheduled
• getNewLogisticsInfoWithScheduledDeliveryChoice
• filterLogisticsInfo
• getNewLogisticsMatchingSelectedAddresses
• mergeLogisticsInfos

SLA

• hasSLAs
• hasDeliveryWindows
• excludePickupTypeFromSlas
• getSlaObj
• getSlaType
• changeSelectedSla
• getSelectedSla
• getSelectedSlas
• getPickupSelectedSlas

parcelify(order, options)

Returns an array of Parcels.

order

An order shaped like an orderForm.

options.criteria

Type: Object Default:

{
  groupBySelectedSlaType: false,
  groupByAvailableDeliveryWindows: false,
  slaOptions: false,
  selectedSla: true,
  seller: true,
  shippingEstimate: true,
  deliveryChannel: true,
  useMarketplaceItems: true
}

This param will be merged with the default options.

Parcel

@vtex/delivery-packages/

A Parcel object shape

{
  address: Object,
  listPrice: Number,
  price: Number,
  sellingPrice: Number,
  pickupFriendlyName: String,
  seller: String,
  items: [Object],
  package: Object,
  selectedSla: String,
  selectedSlaObj: Object,
  slas: [Object],
  shippingEstimate: String,
  shippingEstimateDate: String,
  deliveryChannel: String,
  selectedSlaType: String,
  deliveryIds: [Object]
}

address

The address used for that parcel. If it is a pickup point, the address of the pickup point is returned.

pickupFriendlyName

If the parcel is delivered to a pickup point, this field has its friendly name.

items

The items of the parcel.

seller

The seller of the parcel.

package

The package object from packageAttachment, if it is one.

slas, selectedSla, shippingEstimate, shippingEstimateDate, deliveryChannel, deliveryIds

These properties are taken from the logisticsInfo of the parcel.

Example

const parcelify = require('@vtex/delivery-packages')

const order = {
  items: [
    // You can pass all the properties of the item. That's simplified.
    { id: 0, quantity: 1, seller: '1' },
    { id: 1, quantity: 1, seller: '1' },
  ],
  shippingData: {
    selectedAddresses: [{ addressId: '-4556418741084', street: 'Rua Barão' }],
    logisticsInfo: [
      {
        // You can pass all the properties of the logisticsInfo
        addressId: '-4556418741084',
        selectedSla: 'Expressa',
        shippingEstimate: '5bd',
        shippingEstimateDate: '2018-02-23T19:01:07.0336412+00:00',
        deliveryChannel: 'delivery',
        itemIndex: 0,
        slas: [
          // You can pass all the properties of the sla
          { id: 'Expressa', deliveryChannel: 'delivery', price: 20000 },
        ],
      },
      {
        addressId: '-4556418741084',
        selectedSla: 'Normal',
        shippingEstimate: '6bd',
        shippingEstimateDate: '2018-02-24T19:01:07.0336412+00:00',
        deliveryChannel: 'delivery',
        itemIndex: 1,
        slas: [{ id: 'Normal', deliveryChannel: 'delivery', price: 20000 }],
      },
    ],
  },
  packageAttachment: {
    packages: [
      {
        // You can pass all the properties of tha package.
        courierStatus: { finished: false },
        trackingNumber: '123',
        trackingUrl: '',
        invoiceNumber: '456',
        items: [{ itemIndex: 0, quantity: 1 }],
      },
    ],
  },
}

parcelify(order, { criteria: { seller: false } })
// [
//   {
//     "package": {
//       "courierStatus": { "finished": false },
//       "trackingNumber": "123",
//       "trackingUrl": "",
//       "invoiceNumber": "456",
//       "items": [
//         { "itemIndex": 0, "quantity": 1 }
//       ],
//       "index": 0
//     },
//     "address": { "addressId": "-4556418741084", "street": "Rua Barão" },
//     "price": 20000,
//     "pickupFriendlyName": null,
//     "selectedSla": "Expressa",
//     "selectedSlaObj": { "id": "Expressa", "deliveryChannel": "delivery" },
//     "slas": [{ "id": "Expressa", "deliveryChannel": "delivery" }],
//     "shippingEstimate": "5bd",
//     "shippingEstimateDate": "2018-02-23T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "selectedSlaType": "delivery",
//     "items": [
//       { "id": 0, "quantity": 1, "seller": "1", "index": 0 }
//     ],
//     "seller": "1"
//   },
//   {
//     "address": { "addressId": "-4556418741084", "street": "Rua Barão" },
//     "price": 10000,
//     "pickupFriendlyName": null,
//     "selectedSla": "Normal",
//     "selectedSlaObj": { "id": "Normal", "deliveryChannel": "delivery" },
//     "slas": [{ "id": "Normal", "deliveryChannel": "delivery" }],
//     "shippingEstimate": "6bd",
//     "shippingEstimateDate": "2018-02-24T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "selectedSlaType": "delivery",
//     "items": [
//       { "id": 1, "quantity": 1, "seller": "1", "index": 1 }
//     ],
//     "seller": "1"
//   }
// ]

Address

@vtex/delivery-packages/dist/address

addAddressId (address)

Add property addressId with random hash string (uuid) if not present on address object passed

Usage

const { addAddressId } = require('@vtex/delivery-packages/dist/address')

addAddressId({
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
})
// -> {
//   addressId: '935befd9-dcc3-45f3-e327-9d8611e43630',
//   addressType: 'residential',
//   receiverName: 'John Doe',
//   street: 'Rua Barão',
//   number: '2',
//   complement: null,
//   neighborhood: 'Botafogo',
//   postalCode: '22231-100',
//   city: 'Rio de Janeiro',
//   state: 'RJ',
//   country: 'BRA',
//   reference: null,
//   geoCoordinates: [],
// }

addAddressId({
  addressId: '1234',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
})
// -> {
//   addressId: '1234',
//   addressType: 'residential',
//   receiverName: 'John Doe',
//   street: 'Rua Barão',
//   number: '2',
//   complement: null,
//   neighborhood: 'Botafogo',
//   postalCode: '22231-100',
//   city: 'Rio de Janeiro',
//   state: 'RJ',
//   country: 'BRA',
//   reference: null,
//   geoCoordinates: [],
// }

params:

• address Type: object An object containing all address fields like on availableAddresses of orderForm

returns:

• newAddress Type: object An object containing all address fields like on availableAddresses of orderForm with an addressId included

addPickupPointAddresses (addresses, pickupSlas)

Add all addresses present on pickupSlas that are not already on addresses list

Usage

const { addPickupPointAddresses } = require('@vtex/delivery-packages/dist/address')

addPickupPointAddresses([{
  addressId: '1234',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}], [{
  id: 'Retirada normal',
  deliveryChannel: 'pickup-in-point',
  pickupStoreInfo: {
    isPickupStore: true,
    friendlyName: 'Shopping da Gávea',
    address: {
      addressId: '141125e',
      addressType: 'pickup',
      city: 'Rio de Janeiro',
      complement: '',
      country: 'BRA',
      geoCoordinates: [-43.18080139160156, -22.96540069580078],
      neighborhood: 'Copacabana',
      number: '5',
      postalCode: '22011050',
      receiverName: null,
      reference: null,
      state: 'RJ',
      street: 'Rua General Azevedo Pimentel',
    },
  },
}])
// -> [{
//   addressId: '1234',
//   addressType: 'residential',
//   receiverName: 'John Doe',
//   street: 'Rua Barão',
//   number: '2',
//   complement: null,
//   neighborhood: 'Botafogo',
//   postalCode: '22231-100',
//   city: 'Rio de Janeiro',
//   state: 'RJ',
//   country: 'BRA',
//   reference: null,
//   geoCoordinates: [],
// }, {
//   addressId: '141125e',
//   addressType: 'pickup',
//   city: 'Rio de Janeiro',
//   complement: '',
//   country: 'BRA',
//   geoCoordinates: [-43.18080139160156, -22.96540069580078],
//   neighborhood: 'Copacabana',
//   number: '5',
//   postalCode: '22011050',
//   receiverName: null,
//   reference: null,
//   state: 'RJ',
//   street: 'Rua General Azevedo Pimentel',
// }]

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on availableAddresses of orderForm
• pickupSlas Type: Array<object> An array which each item is an object containing a list of slas of the pickup-in-point deliveryChannel

returns:

• newAddresses Type: Array<object> New list of addresses containing the pickup addresses

findAddressIndex (addresses, searchAddress)

Find a reference address index on addresses list according to the reference addressId or -1 if it doesn't find it

Usage

const { findAddressIndex } = require('@vtex/delivery-packages/dist/address')

findAddressIndex([{
  addressId: '935befd9-dcc3-45f3-e327-9d8611e43630',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}, {
  addressId: '783978bd-e71c-4602-4bc6-387cc68f226d',
  addressType: 'commercial',
  receiverName: 'John Doe',
  street: 'Rua dos bobos',
  number: '0',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22250-040',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}], { addressId: '935befd9-dcc3-45f3-e327-9d8611e43630' })
// -> 0

findAddressIndex([{
  addressId: '935befd9-dcc3-45f3-e327-9d8611e43630',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}, {
  addressId: '783978bd-e71c-4602-4bc6-387cc68f226d',
  addressType: 'commercial',
  receiverName: 'John Doe',
  street: 'Rua dos bobos',
  number: '0',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22250-040',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}], { addressId: 'not-found' })
// -> -1

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on availableAddresses of orderForm
• searchAddress Type: object An object with addressId reference to be used to search

returns:

• index Type: number Position on addresses of the searchAddress reference according to its addressId

findAddress (addresses, searchAddress)

Find a reference address on addresses list according to the reference addressId or null if it doesn't find it

Usage

const { findAddress } = require('@vtex/delivery-packages/dist/address')

findAddress([{
  addressId: '935befd9-dcc3-45f3-e327-9d8611e43630',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}, {
  addressId: '783978bd-e71c-4602-4bc6-387cc68f226d',
  addressType: 'commercial',
  receiverName: 'John Doe',
  street: 'Rua dos bobos',
  number: '0',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22250-040',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}], { addressId: '935befd9-dcc3-45f3-e327-9d8611e43630' })
// -> {
//   addressId: '935befd9-dcc3-45f3-e327-9d8611e43630',
//   addressType: 'residential',
//   receiverName: 'John Doe',
//   street: 'Rua Barão',
//   number: '2',
//   complement: null,
//   neighborhood: 'Botafogo',
//   postalCode: '22231-100',
//   city: 'Rio de Janeiro',
//   state: 'RJ',
//   country: 'BRA',
//   reference: null,
//   geoCoordinates: []
// }

findAddress([{
  addressId: '935befd9-dcc3-45f3-e327-9d8611e43630',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}, {
  addressId: '783978bd-e71c-4602-4bc6-387cc68f226d',
  addressType: 'commercial',
  receiverName: 'John Doe',
  street: 'Rua dos bobos',
  number: '0',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22250-040',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}], { addressId: 'not-found' })
// -> null

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on availableAddresses of orderForm
• searchAddress Type: object An object with addressId reference to be used to search

returns:

• addressFound Type: object The address found

findAddressByPostalCode (addresses, searchAddress)

Works like findAddress above but the searchAddress postalCode property is used instead

Usage

const { findAddress } = require('@vtex/delivery-packages/dist/address')

findAddress([{
  addressId: '935befd9-dcc3-45f3-e327-9d8611e43630',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}, {
  addressId: '783978bd-e71c-4602-4bc6-387cc68f226d',
  addressType: 'commercial',
  receiverName: 'John Doe',
  street: 'Rua dos bobos',
  number: '0',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22250-040',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}], { postalCode: '22250-040' })
// -> {
//   addressId: '783978bd-e71c-4602-4bc6-387cc68f226d',
//   addressType: 'commercial',
//   receiverName: 'John Doe',
//   street: 'Rua dos bobos',
//   number: '0',
//   complement: null,
//   neighborhood: 'Botafogo',
//   postalCode: '22250-040',
//   city: 'Rio de Janeiro',
//   state: 'RJ',
//   country: 'BRA',
//   reference: null,
//   geoCoordinates: [],
// }

isAddressComplete (address)

Verify address has all required basic fields

Usage

const { isAddressComplete } = require('@vtex/delivery-packages/dist/address')

isAddressComplete({
  addressId: '-4556418741084',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
})
// -> true

isAddressComplete({
  addressId: '-4556418741084',
  addressType: 'residential',
  receiverName: null,
  reference: null,
  geoCoordinates: [],
})
// -> false

isAddressComplete({
  addressId: '-4556418741084',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: null,
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
}, [
  'state',
  'city',
  'neighborhood',
  'street',
])
// -> true

params:

• address Type: object An object containing all address fields like on availableAddresses of orderForm

• requiredFields Type: array An array containing all required fields. The default required address fields are state, city, neighborhood, street and number.

returns:

• isAddressComplete Type: boolean If the address has all required fields

isPickupAddress (address)

Verify address refers to a pickup point

Usage

const { isPickupAddress } = require('@vtex/delivery-packages/dist/address')

isPickupAddress({
  addressId: '-4556418741084',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
})
// -> false

isPickupAddress({
  addressId: '141125d',
  addressType: 'pickup',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [-43.18080139160156, -22.96540069580078],
  neighborhood: 'Copacabana',
  number: '5',
  postalCode: '22011050',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Rua General Azevedo Pimentel',
})
// -> true

params:

• address Type: object An object containing all address fields like on availableAddresses of orderForm

returns:

• isPickupAddress Type: boolean If the address refers to a pickup point

isDeliveryAddress (address)

Verify address refers to a residential address (to deliver items)

Usage

const { isDeliveryAddress } = require('@vtex/delivery-packages/dist/address')

isDeliveryAddress({
  addressId: '-4556418741084',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
})
// -> true

isDeliveryAddress({
  addressId: '141125d',
  addressType: 'pickup',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [-43.18080139160156, -22.96540069580078],
  neighborhood: 'Copacabana',
  number: '5',
  postalCode: '22011050',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Rua General Azevedo Pimentel',
})
// -> false

params:

• address Type: object An object containing all address fields like on availableAddresses of orderForm

returns:

• isDeliveryAddress Type: boolean If the address refers to a residential address (to deliver items)

isGiftRegistry (address)

Verify address refers to a gift list address

Usage

const { isGiftRegistry } = require('@vtex/delivery-packages/dist/address')

isGiftRegistry({
  addressId: '-4556418741084',
  addressType: 'residential',
  receiverName: 'John Doe',
  street: 'Rua Barão',
  number: '2',
  complement: null,
  neighborhood: 'Botafogo',
  postalCode: '22231-100',
  city: 'Rio de Janeiro',
  state: 'RJ',
  country: 'BRA',
  reference: null,
  geoCoordinates: [],
})
// -> false

isGiftRegistry({
  addressId: '141125d',
  addressType: 'giftRegistry',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [-43.18080139160156, -22.96540069580078],
  neighborhood: 'Copacabana',
  number: '5',
  postalCode: '22011050',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Rua General Azevedo Pimentel',
})
// -> true

params:

• address Type: object An object containing all address fields like on availableAddresses of orderForm

returns:

• isGiftRegistry Type: boolean If the address refers to a gift list address

getDeliveryAvailableAddresses (addresses)

Filter only residential and complete address

Usage

const { getDeliveryAvailableAddresses } = require('@vtex/delivery-packages/dist/address')

getDeliveryAvailableAddresses([
  {
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  },
  {
    addressId: '141125d',
    addressType: 'pickup',
    city: 'Rio de Janeiro',
    complement: '',
    country: 'BRA',
    geoCoordinates: [-43.18080139160156, -22.96540069580078],
    neighborhood: 'Copacabana',
    number: '5',
    postalCode: '22011050',
    receiverName: 'auto auto',
    reference: null,
    state: 'RJ',
    street: 'Rua General Azevedo Pimentel',
  }
])
// -> [
//   {
//     addressId: '-4556418741084',
//     addressType: 'residential',
//     receiverName: 'John Doe',
//     street: 'Rua Barão',
//     number: '2',
//     complement: null,
//     neighborhood: 'Botafogo',
//     postalCode: '22231-100',
//     city: 'Rio de Janeiro',
//     state: 'RJ',
//     country: 'BRA',
//     reference: null,
//     geoCoordinates: [],
//   }
// ]

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on availableAddresses of orderForm

returns:

• filteredAddresses Type: Array<object> Filtered addresses that contain only residential and complete address

groupByAddressType (addresses)

Create an object where each key is an address type and each value is an array of addresses grouped by each address type

Usage

const { groupByAddressType } = require('@vtex/delivery-packages/dist/address')

groupByAddressType([
  {
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  },
  {
    addressId: '141125d',
    addressType: 'pickup',
    city: 'Rio de Janeiro',
    complement: '',
    country: 'BRA',
    geoCoordinates: [-43.18080139160156, -22.96540069580078],
    neighborhood: 'Copacabana',
    number: '5',
    postalCode: '22011050',
    receiverName: 'auto auto',
    reference: null,
    state: 'RJ',
    street: 'Rua General Azevedo Pimentel',
  }
])
// -> {
//   residential: [{
//     addressId: '-4556418741084',
//     addressType: 'residential',
//     receiverName: 'John Doe',
//     street: 'Rua Barão',
//     number: '2',
//     complement: null,
//     neighborhood: 'Botafogo',
//     postalCode: '22231-100',
//     city: 'Rio de Janeiro',
//     state: 'RJ',
//     country: 'BRA',
//     reference: null,
//     geoCoordinates: [],
//   }],
//   pickup: [{
//     addressId: '141125d',
//     addressType: 'pickup',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [-43.18080139160156, -22.96540069580078],
//     neighborhood: 'Copacabana',
//     number: '5',
//     postalCode: '22011050',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Rua General Azevedo Pimentel',
//   }]
// }

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on selectedAddresses of orderForm

returns:

• group of addresses Type: object An object where each key is an address type and each value is an array of addresses grouped by each address type

addOrReplaceAddressTypeOnList (addresses, newAddress)

Adds new address if the addressType of newAddress is not found or replace an existing address of that type

Usage

const { addOrReplaceAddressTypeOnList } = require('@vtex/delivery-packages/dist/address')

addOrReplaceAddressTypeOnList([
  {
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  }
],
{
  addressId: '141125d',
  addressType: 'pickup',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [-43.18080139160156, -22.96540069580078],
  neighborhood: 'Copacabana',
  number: '5',
  postalCode: '22011050',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Rua General Azevedo Pimentel',
})
// -> [
//   {
//     addressId: '-4556418741084',
//     addressType: 'residential',
//     receiverName: 'John Doe',
//     street: 'Rua Barão',
//     number: '2',
//     complement: null,
//     neighborhood: 'Botafogo',
//     postalCode: '22231-100',
//     city: 'Rio de Janeiro',
//     state: 'RJ',
//     country: 'BRA',
//     reference: null,
//     geoCoordinates: [],
//   },
//   {
//     addressId: '141125d',
//     addressType: 'pickup',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [-43.18080139160156, -22.96540069580078],
//     neighborhood: 'Copacabana',
//     number: '5',
//     postalCode: '22011050',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Rua General Azevedo Pimentel',
//   }
// ]

addOrReplaceAddressTypeOnList([
  {
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  },
  {
    addressId: '141125d',
    addressType: 'pickup',
    city: 'Rio de Janeiro',
    complement: '',
    country: 'BRA',
    geoCoordinates: [-43.18080139160156, -22.96540069580078],
    neighborhood: 'Copacabana',
    number: '5',
    postalCode: '22011050',
    receiverName: 'auto auto',
    reference: null,
    state: 'RJ',
    street: 'Rua General Azevedo Pimentel',
  }
], {
  addressId: '1234',
  addressType: 'pickup',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [],
  neighborhood: 'Botafogo',
  number: '300',
  postalCode: '22250040',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Praia de botafogo',
})
// -> [
//   {
//     addressId: '-4556418741084',
//     addressType: 'residential',
//     receiverName: 'John Doe',
//     street: 'Rua Barão',
//     number: '2',
//     complement: null,
//     neighborhood: 'Botafogo',
//     postalCode: '22231-100',
//     city: 'Rio de Janeiro',
//     state: 'RJ',
//     country: 'BRA',
//     reference: null,
//     geoCoordinates: [],
//   },
//   {
//     addressId: '1234',
//     addressType: 'pickup',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [],
//     neighborhood: 'Botafogo',
//     number: '300',
//     postalCode: '22250040',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Praia de botafogo',
//   }
// ]

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on selectedAddresses of orderForm
• newAddress Type: string New address to be included on the list of addresses

returns:

• new addresses Type: object New list of addresses with the newAddress included

addOrReplaceAddressOnList (addresses, newAddress)

Adds new address if the newAddress is not found or replace an existing address with the same addressId

Usage

const { addOrReplaceAddressOnList } = require('@vtex/delivery-packages/dist/address')

addOrReplaceAddressOnList([
  {
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  }
],
{
  addressId: '141125d',
  addressType: 'pickup',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [-43.18080139160156, -22.96540069580078],
  neighborhood: 'Copacabana',
  number: '5',
  postalCode: '22011050',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Rua General Azevedo Pimentel',
})
// -> [
//   {
//     addressId: '-4556418741084',
//     addressType: 'residential',
//     receiverName: 'John Doe',
//     street: 'Rua Barão',
//     number: '2',
//     complement: null,
//     neighborhood: 'Botafogo',
//     postalCode: '22231-100',
//     city: 'Rio de Janeiro',
//     state: 'RJ',
//     country: 'BRA',
//     reference: null,
//     geoCoordinates: [],
//   },
//   {
//     addressId: '141125d',
//     addressType: 'pickup',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [-43.18080139160156, -22.96540069580078],
//     neighborhood: 'Copacabana',
//     number: '5',
//     postalCode: '22011050',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Rua General Azevedo Pimentel',
//   }
// ]

addOrReplaceAddressTypeOnList([
  {
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  },
  {
    addressId: '1234',
    addressType: 'pickup',
    city: 'Rio de Janeiro',
    complement: '',
    country: 'BRA',
    geoCoordinates: [-43.18080139160156, -22.96540069580078],
    neighborhood: 'Copacabana',
    number: '5',
    postalCode: '22011050',
    receiverName: 'auto auto',
    reference: null,
    state: 'RJ',
    street: 'Rua General Azevedo Pimentel',
  }
], {
  addressId: '1234',
  addressType: 'pickup',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [],
  neighborhood: 'Botafogo',
  number: '300',
  postalCode: '22250040',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Praia de botafogo',
})
// -> [
//   {
//     addressId: '-4556418741084',
//     addressType: 'residential',
//     receiverName: 'John Doe',
//     street: 'Rua Barão',
//     number: '2',
//     complement: null,
//     neighborhood: 'Botafogo',
//     postalCode: '22231-100',
//     city: 'Rio de Janeiro',
//     state: 'RJ',
//     country: 'BRA',
//     reference: null,
//     geoCoordinates: [],
//   },
//   {
//     addressId: '1234',
//     addressType: 'pickup',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [],
//     neighborhood: 'Botafogo',
//     number: '300',
//     postalCode: '22250040',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Praia de botafogo',
//   }
// ]

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on selectedAddresses of orderForm
• newAddress Type: string New address to be included on the list of addresses

returns:

• new addresses Type: object New list of addresses with the newAddress included

setDeliveryAddressOnList (addresses, newAddress)

Adds a new address if no delivery address exists on addresses and the addressType of newAddress is delivery or replace an existing delivery address with the current delivery address merged with the newAddress data.

Usage

const { setDeliveryAddressOnList } = require('@vtex/delivery-packages/dist/address')

setDeliveryAddressOnList([
  {
    addressId: '141125d',
    addressType: 'pickup',
    city: 'Rio de Janeiro',
    complement: '',
    country: 'BRA',
    geoCoordinates: [-43.18080139160156, -22.96540069580078],
    neighborhood: 'Copacabana',
    number: '5',
    postalCode: '22011050',
    receiverName: 'auto auto',
    reference: null,
    state: 'RJ',
    street: 'Rua General Azevedo Pimentel',
  }
],

{
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  })
// -> [
//   {
//     addressId: '141125d',
//     addressType: 'pickup',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [-43.18080139160156, -22.96540069580078],
//     neighborhood: 'Copacabana',
//     number: '5',
//     postalCode: '22011050',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Rua General Azevedo Pimentel',
//   },
//   {
//     addressId: '-4556418741084',
//     addressType: 'residential',
//     receiverName: 'John Doe',
//     street: 'Rua Barão',
//     number: '2',
//     complement: null,
//     neighborhood: 'Botafogo',
//     postalCode: '22231-100',
//     city: 'Rio de Janeiro',
//     state: 'RJ',
//     country: 'BRA',
//     reference: null,
//     geoCoordinates: [],
//   },
// ]

setDeliveryAddressOnList([
  {
    addressId: '-4556418741084',
    addressType: 'residential',
    receiverName: 'John Doe',
    street: 'Rua Barão',
    number: '2',
    complement: null,
    neighborhood: 'Botafogo',
    postalCode: '22231-100',
    city: 'Rio de Janeiro',
    state: 'RJ',
    country: 'BRA',
    reference: null,
    geoCoordinates: [],
  },
  {
    addressId: '141125d',
    addressType: 'pickup',
    city: 'Rio de Janeiro',
    complement: '',
    country: 'BRA',
    geoCoordinates: [-43.18080139160156, -22.96540069580078],
    neighborhood: 'Copacabana',
    number: '5',
    postalCode: '22011050',
    receiverName: 'auto auto',
    reference: null,
    state: 'RJ',
    street: 'Rua General Azevedo Pimentel',
  }
], {
  addressId: '1234',
  addressType: 'commercial',
  city: 'Rio de Janeiro',
  complement: '',
  country: 'BRA',
  geoCoordinates: [],
  neighborhood: 'Botafogo',
  number: '300',
  postalCode: '22250040',
  receiverName: 'auto auto',
  reference: null,
  state: 'RJ',
  street: 'Praia de botafogo',
})
// -> [
//   {
//     addressId: '1234',
//     addressType: 'commercial',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [],
//     neighborhood: 'Botafogo',
//     number: '300',
//     postalCode: '22250040',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Praia de botafogo',
//   },
//   {
//     addressId: '1234',
//     addressType: 'pickup',
//     city: 'Rio de Janeiro',
//     complement: '',
//     country: 'BRA',
//     geoCoordinates: [],
//     neighborhood: 'Botafogo',
//     number: '300',
//     postalCode: '22250040',
//     receiverName: 'auto auto',
//     reference: null,
//     state: 'RJ',
//     street: 'Praia de botafogo',
//   }
// ]

params:

• addresses Type: Array<object> An array which each item is an object containing all address fields like on selectedAddresses of orderForm
• newAddress Type: object New address to be included on the list of addresses

returns:

• new addresses Type: Array<object> New list of addresses with the newAddress included

Delivery Channel

@vtex/delivery-packages/dist/delivery-channel

getDeliveryChannel (deliveryChannelSource)

Get the delivery channel string of a delivery channel source.

Usage

const {
  getDeliveryChannel,
} = require('@vtex/delivery-packages/dist/delivery-channel')

getDeliveryChannel({ id: 'pickup-in-point' })
// -> 'pickup-in-point'

params:

• deliveryChannelSource Type: object or string An object containing a deliveryChannel string or the string itself

returns:

• deliveryChannel Type: string The deliveryChannel string (generally 'pickup-in-point' or 'delivery')

isPickup (deliveryChannelSource)

Check if the delivery channel source is a pickup point.

Usage

const { isPickup } = require('@vtex/delivery-packages/dist/delivery-channel')

isPickup({ id: 'pickup-in-point' })
// -> true

isPickup({ selectedDeliveryChannel: 'pickup-in-point' })
// true

isPickup({ deliveryChannel: 'pickup-in-point' })
// true

isPickup({ id: 'delivery' })
// -> false

params:

• deliveryChannelSource Type: object or string An object containing a deliveryChannel string or the string itself

returns:

• isPickup Type: boolean true or false

isDelivery (deliveryChannelSource)

Check if the delivery channel source is a delivery.

Usage

const { isDelivery } = require('@vtex/delivery-packages/dist/delivery-channel')

isDelivery({ id: 'pickup-in-point' })
// -> false

isDelivery({ selectedDeliveryChannel: 'delivery' })
// true

isDelivery({ deliveryChannel: 'delivery' })
// true

isDelivery({ id: 'delivery' })
// -> true

params:

• deliveryChannelSource Type: object or string An object containing a deliveryChannel string or the string itself

returns:

• isDelivery Type: boolean true or false

findChannelById (logisticsInfoItem, deliveryChannelSource)

Search for a delivery channel object from an object container a list of delivery channel objects (usually it will be a logisticsInfo item).

Usage

const {
  findChannelById,
} = require('@vtex/delivery-packages/dist/delivery-channel')

findChannelById({ deliveryChannels: [{ id: 'delivery' }] }, 'pickup-in-point')
// -> null

findChannelById(
  { deliveryChannels: [{ id: 'delivery' }, { id: 'pickup-in-point' }] },
  'delivery'
)
// -> { id: 'delivery' }

params:

• logisticsInfoItem Type: object An object containing a deliveryChannels array
• deliveryChannelSource Type: object or string An object containing a deliveryChannel string or the string itself

returns:

• deliveryChannel Type: object Object like { id: 'delivery' } or { id: 'pickup-in-point' }

Items

@vtex/delivery-packages/dist/items

getNewItems (items, changes)

Get new items based on the ones passed and an array of changes.

Usage

const { getNewItems } = require('@vtex/delivery-packages/dist/items')

const items = [
  { id: 10, quantity: 1, seller: '1' },
  { id: 11, quantity: 1, seller: '1' },
]
const changes = [
  { itemsAdded: [{ id: 12, quantity: 1, seller: '1' }] },
  { itemsRemoved: [{ id: 11, quantity: 1, seller: '1' }] },
]

getNewItems(items, changes)
// -> [{ id: 10, quantity: 1, seller: '1' }, { id: 12, quantity: 1, seller: '1'}]

params:

• items Type: Array<object> Array of items (like the ones in an orderForm)

• changes Type: Array<object> Array of changes, each change on the format { itemsAdded: Array<item>, itemsRemoved: Array<item> }

returns:

• new items Type: Array<object> New array of items with the changes applied

getDeliveredItems ({ items, packages })

Merge items with packages and organize them based if they were already delivered or will be delivered.

Usage

const { getDeliveredItems } = require('@vtex/delivery-packages/dist/items')

const items = [
  { id: 10, quantity: 1, seller: '1', index: 0 },
  { id: 11, quantity: 1, seller: '1', index: 1 },
]
const packages = [
  {
    courierStatus: { finished: false },
    index: 0,
    invoiceNumber: '456',
    items: [{ itemIndex: 0, quantity: 1 }, { itemIndex: 1, quantity: 1 }],
    trackingNumber: '123',
    trackingUrl: '',
  },
]

getDeliveredItems({ items, packages })
// -> {
//   delivered: [
//     {
//       item: { id: '10', index: 0, quantity: 1, seller: '1' },
//       package: {
//         courierStatus: { finished: false },
//         index: 0,
//         invoiceNumber: '456',
//         items: [{ itemIndex: 0, quantity: 1 }, { itemIndex: 1, quantity: 1 }],
//         trackingNumber: '123',
//         trackingUrl: '',
//       },
//     },
//   ],
//   toBeDelivered: [{ item: { id: '1', index: 1, quantity: 1, seller: '1' } }],
// }

params:

• deliveryContext Type: object Object on the format { items, packages } containing the items and packages of an order, with the index of each item and package

returns:

• items with packages Type: object Object contained the keys delivered and toBeDelivered containing the right items and packages

getItemsIndexes (items)

Return multiple values with information about the items indexes

Usage

const { getItemsIndexes } = require('@vtex/delivery-packages/dist/items')

const items = [
  { itemIndex: 0, sla: 'sla1' },
  { itemIndex: 2, sla: 'sla2' },
]

getItemsIndexes(items)
// -> {
//   indexes: [0, 2],
//   otherIndexes: [1],
//   indexesMap: { 0: items[0], 2: items[1] },
//   maxIndex: 2,
// }

params:

• items Type: Array<object> Array of items with itemIndex keys like the logisticsInfo of the orderForm

returns:

• indexes context Type: { indexes: Array<number>, otherIndexes: Array<number>, indexesMap: object, maxIndex: number}

indexes: an array with all the numbers matching the items passed

otherIndexes: an array with all the numbers not matching the items passed until maxIndex

indexesMap: an object where the keys are the indexes and the values are the original items

maxIndex: the maximum index found in the list of items

Scheduled Delivery

@vtex/delivery-packages/dist/scheduled-delivery

areAvailableDeliveryWindowsEquals (availableDeliveryWindows1, availableDeliveryWindows2)

Check if two available delivery windows are equal.

Usage

const {
  areAvailableDeliveryWindowsEquals,
} = require('@vtex/delivery-packages/dist/scheduled-delivery')

const availableDeliveryWindows1 = [
  {
    startDateUtc: '2018-05-26T09:00:00+00:00',
    endDateUtc: '2018-05-26T21:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
]

const availableDeliveryWindows2 = [
  {
    startDateUtc: '2018-05-26T09:00:00+00:00',
    endDateUtc: '2018-05-26T21:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
]

const availableDeliveryWindows3 = [
  {
    startDateUtc: '2018-06-20T09:00:00+00:00',
    endDateUtc: '2018-06-20T21:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
]

areAvailableDeliveryWindowsEquals(
  availableDeliveryWindows1,
  availableDeliveryWindows2
)
// -> true

areAvailableDeliveryWindowsEquals(
  availableDeliveryWindows1,
  availableDeliveryWindows3
)
// -> false

params:

• availableDeliveryWindows1 Type: Array<object> Array of objects, each object with startDateUtc, endDateUtc, price, lisPrice and tax properties (like inside logisticsInfo[i].slas that have scheduled deliveries)

• availableDeliveryWindows2 Type: Array<object> Array of objects, each object with startDateUtc, endDateUtc, price, lisPrice and tax properties (like inside logisticsInfo[i].slas that have scheduled deliveries)

returns:

• are equal Type: boolean true or false

selectDeliveryWindow (logisticsInfo, { selectedSla, deliveryWindow })

Get new logisticsInfo with the deliveryWindow of the selectedSla inserted.

Usage

const {
  selectDeliveryWindow,
} = require('@vtex/delivery-packages/dist/scheduled-delivery')

const logisticsInfo = [
  {
    // You can pass all the properties of the logisticsInfo
    addressId: '-4556418741084',
    selectedSla: 'Agendada',
    shippingEstimate: '5bd',
    shippingEstimateDate: '2018-02-23T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 0,
    slas: [
      // You can pass all the properties of the sla
      {
        id: 'Agendada',
        deliveryChannel: 'delivery',
        availableDeliveryWindows: [
          {
            startDateUtc: '2018-05-26T09:00:00+00:00',
            endDateUtc: '2018-05-26T21:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
          {
            startDateUtc: '2018-05-26T12:00:00+00:00',
            endDateUtc: '2018-05-26T13:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
        ],
      },
    ],
  },
  {
    addressId: '-4556418741084',
    selectedSla: 'Normal',
    shippingEstimate: '6bd',
    shippingEstimateDate: '2018-02-24T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 1,
    slas: [{ id: 'Normal', deliveryChannel: 'delivery' }],
  },
]

selectDeliveryWindow(logisticsInfo, {
  selectedSla: 'Agendada',
  deliveryWindow: {
    startDateUtc: '2018-05-26T09:00:00+00:00',
    endDateUtc: '2018-05-26T21:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
})
// -> [
//   {
//     // You can pass all the properties of the logisticsInfo
//     "addressId": "-4556418741084",
//     "selectedSla": "Agendada",
//     "shippingEstimate": "5bd",
//     "shippingEstimateDate": "2018-02-23T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 0,
//     "deliveryWindow": {
//       startDateUtc: '2018-05-26T09:00:00+00:00',
//       endDateUtc: '2018-05-26T21:00:00+00:00',
//       price: 500,
//       lisPrice: 500,
//       tax: 0,
//     },
//     "slas": [
//       // You can pass all the properties of the sla
//       {
//         "id": "Agendada",
//         "deliveryChannel": "delivery",
//         "deliveryWindow": {
//           startDateUtc: '2018-05-26T09:00:00+00:00',
//           endDateUtc: '2018-05-26T21:00:00+00:00',
//           price: 500,
//           lisPrice: 500,
//           tax: 0,
//         },
//         "availableDeliveryWindows": [
//           {
//             startDateUtc: '2018-05-26T09:00:00+00:00',
//             endDateUtc: '2018-05-26T21:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           },
//           {
//             startDateUtc: '2018-05-26T12:00:00+00:00',
//             endDateUtc: '2018-05-26T13:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           }
//         ]
//       }
//     ]
//   },
//   {
//     "addressId": "-4556418741084",
//     "selectedSla": "Normal",
//     "shippingEstimate": "6bd",
//     "shippingEstimateDate": "2018-02-24T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 1,
//     "slas": [
//       { "id": "Normal", "deliveryChannel": "delivery" }
//     ]
//   }
// ]

params:

• logisticsInfo Type: Array<object> The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slas

• action Type: object Object on the format { selectedSla, deliveryWindow }, selectedSla being a string with the id of the selectedSla of each logisticsInfo item and deliveryWindow being an object of the availableDeliveryWindows on these items

returns:

• new logisticsInfo Type: Array<object> The new logisticsInfo with the deliveryWindow selected on the matching items that have the selectedSla passed

getFirstScheduledDelivery (logisticsInfo, availableDeliveryWindows = null)

Get the first sla with scheduled delivery matching the availableDeliveryWindows passed.

Usage

const {
  getFirstScheduledDelivery,
} = require('@vtex/delivery-packages/dist/scheduled-delivery')

const logisticsInfo = [
  {
    // You can pass all the properties of the logisticsInfo
    addressId: '-4556418741084',
    selectedSla: 'Agendada',
    shippingEstimate: '5bd',
    shippingEstimateDate: '2018-02-23T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 0,
    slas: [
      // You can pass all the properties of the sla
      {
        id: 'Agendada',
        deliveryChannel: 'delivery',
        availableDeliveryWindows: [
          {
            startDateUtc: '2018-05-26T09:00:00+00:00',
            endDateUtc: '2018-05-26T21:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
          {
            startDateUtc: '2018-05-26T12:00:00+00:00',
            endDateUtc: '2018-05-26T13:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
        ],
      },
    ],
  },
  {
    addressId: '-4556418741084',
    selectedSla: 'Normal',
    shippingEstimate: '6bd',
    shippingEstimateDate: '2018-02-24T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 1,
    slas: [{ id: 'Normal', deliveryChannel: 'delivery' }],
  },
]

getFirstScheduledDelivery(logisticsInfo, [
  {
    startDateUtc: '2018-05-26T09:00:00+00:00',
    endDateUtc: '2018-05-26T21:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
  {
    startDateUtc: '2018-05-26T12:00:00+00:00',
    endDateUtc: '2018-05-26T13:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
])
// ->
// {
//   "id": "Agendada",
//   "deliveryChannel": "delivery",
//   "availableDeliveryWindows": [
//     {
//       startDateUtc: '2018-05-26T09:00:00+00:00',
//       endDateUtc: '2018-05-26T21:00:00+00:00',
//       price: 500,
//       lisPrice: 500,
//       tax: 0,
//     },
//     {
//       startDateUtc: '2018-05-26T12:00:00+00:00',
//       endDateUtc: '2018-05-26T13:00:00+00:00',
//       price: 500,
//       lisPrice: 500,
//       tax: 0,
//     }
//   ]
// }

params:

• logisticsInfo Type: Array<object> The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slas

• availableDeliveryWindows1 Type: Array<object> Array of objects, each object with startDateUtc, endDateUtc, price, lisPrice and tax properties (like inside logisticsInfo[i].slas that have scheduled deliveries). The default value for this parameter is null

returns:

• sla Type: object If availableDeliveryWindows is passed, return the first sla with scheduled delivery matching the availableDeliveryWindows. If availableDeliveryWindows is not passed, return the first scheduled delivery sla that exists

Shipping

@vtex/delivery-packages/dist/shipping

getNewLogisticsInfo (logisticsInfo, selectedSla, availableDeliveryWindows = null)

Get new logisticsInfo with the selectedSla on all items that can receive it as selected.

Usage

const { getNewLogisticsInfo } = require('@vtex/delivery-packages/dist/shipping')

const logisticsInfo = [
  {
    // You can pass all the properties of the logisticsInfo
    addressId: '-4556418741084',
    selectedSla: null,
    selectedDeliveryChannel: null,
    shippingEstimate: '5bd',
    shippingEstimateDate: '2018-02-23T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 0,
    slas: [
      // You can pass all the properties of the sla
      {
        id: 'Agendada',
        deliveryChannel: 'delivery',
        availableDeliveryWindows: [
          {
            startDateUtc: '2018-05-26T09:00:00+00:00',
            endDateUtc: '2018-05-26T21:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
          {
            startDateUtc: '2018-05-26T12:00:00+00:00',
            endDateUtc: '2018-05-26T13:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
        ],
      },
    ],
  },
  {
    addressId: '-4556418741084',
    selectedSla: null,
    selectedDeliveryChannel: null,
    shippingEstimate: '6bd',
    shippingEstimateDate: '2018-02-24T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 1,
    slas: [{ id: 'Normal', deliveryChannel: 'delivery' }],
  },
]

getNewLogisticsInfo(logisticsInfo, 'Normal')
// -> [
//   {
//     // You can pass all the properties of the logisticsInfo
//     "addressId": "-4556418741084",
//     "selectedSla": null,
//     "selectedDeliveryChannel": null,
//     "shippingEstimate": "5bd",
//     "shippingEstimateDate": "2018-02-23T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 0,
//     "slas": [
//       // You can pass all the properties of the sla
//       {
//         "id": "Agendada",
//         "deliveryChannel": "delivery",
//         "availableDeliveryWindows": [
//           {
//             startDateUtc: '2018-05-26T09:00:00+00:00',
//             endDateUtc: '2018-05-26T21:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           },
//           {
//             startDateUtc: '2018-05-26T12:00:00+00:00',
//             endDateUtc: '2018-05-26T13:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           }
//         ]
//       }
//     ]
//   },
//   {
//     "addressId": "-4556418741084",
//     "selectedSla": "Normal",
//     "selectedDeliveryChannel": "delivery",
//     "shippingEstimate": "6bd",
//     "shippingEstimateDate": "2018-02-24T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 1,
//     "slas": [
//       { "id": "Normal", "deliveryChannel": "delivery" }
//     ]
//   }
// ]

getNewLogisticsInfo(logisticsInfo, 'Agendada', [
  {
    startDateUtc: '2018-05-26T09:00:00+00:00',
    endDateUtc: '2018-05-26T21:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
  {
    startDateUtc: '2018-05-26T12:00:00+00:00',
    endDateUtc: '2018-05-26T13:00:00+00:00',
    price: 500,
    lisPrice: 500,
    tax: 0,
  },
])
// -> [
//   {
//     // You can pass all the properties of the logisticsInfo
//     "addressId": "-4556418741084",
//     "selectedSla": "Agendada",
//     "selectedDeliveryChannel": "delivery",
//     "shippingEstimate": "5bd",
//     "shippingEstimateDate": "2018-02-23T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 0,
//     "slas": [
//       // You can pass all the properties of the sla
//       {
//         "id": "Agendada",
//         "deliveryChannel": "delivery",
//         "availableDeliveryWindows": [
//           {
//             startDateUtc: '2018-05-26T09:00:00+00:00',
//             endDateUtc: '2018-05-26T21:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           },
//           {
//             startDateUtc: '2018-05-26T12:00:00+00:00',
//             endDateUtc: '2018-05-26T13:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           }
//         ]
//       }
//     ]
//   },
//   {
//     "addressId": "-4556418741084",
//     "selectedSla": null,
//     "selectedDeliveryChannel": null,
//     "shippingEstimate": "6bd",
//     "shippingEstimateDate": "2018-02-24T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 1,
//     "slas": [
//       { "id": "Normal", "deliveryChannel": "delivery" }
//     ]
//   }
// ]

params:

• logisticsInfo Type: Array<object> The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slas

• selectedSla Type: string The id of the selected sla on logisticsInfo items

• availableDeliveryWindows Type: Array<object> Array of objects, each object with startDateUtc, endDateUtc, price, lisPrice and tax properties (like inside logisticsInfo[i].slas that have scheduled deliveries). The default value for this parameter is null

returns:

• new logisticsInfo Type: Array<object> New logisticsInfo with selectedSla and selectedDeliveryChannel filled correctly on each item with slas that can be selected. Optionally the availableDeliveryWindows can be passed to filter the scheduled delivery slas

getNewLogisticsInfoWithSelectedScheduled (logisticsInfo)

Get new logisticsInfo selecting first sla that has availableDeliveryWindows on each item that can be scheduled delivered.

Usage

const {
  getNewLogisticsInfoWithSelectedScheduled,
} = require('@vtex/delivery-packages/dist/shipping')

const logisticsInfo = [
  {
    // You can pass all the properties of the logisticsInfo
    addressId: '-4556418741084',
    selectedSla: null,
    selectedDeliveryChannel: null,
    shippingEstimate: '5bd',
    shippingEstimateDate: '2018-02-23T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 0,
    slas: [
      // You can pass all the properties of the sla
      {
        id: 'Agendada',
        deliveryChannel: 'delivery',
        availableDeliveryWindows: [
          {
            startDateUtc: '2018-05-26T09:00:00+00:00',
            endDateUtc: '2018-05-26T21:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
          {
            startDateUtc: '2018-05-26T12:00:00+00:00',
            endDateUtc: '2018-05-26T13:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
        ],
      },
    ],
  },
  {
    addressId: '-4556418741084',
    selectedSla: null,
    selectedDeliveryChannel: null,
    shippingEstimate: '6bd',
    shippingEstimateDate: '2018-02-24T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 1,
    slas: [{ id: 'Normal', deliveryChannel: 'delivery' }],
  },
]

getNewLogisticsInfoWithSelectedScheduled(logisticsInfo)
// -> [
//   {
//     // You can pass all the properties of the logisticsInfo
//     "addressId": "-4556418741084",
//     "selectedSla": 'Agendada',
//     "selectedDeliveryChannel": 'delivery',
//     "shippingEstimate": "5bd",
//     "shippingEstimateDate": "2018-02-23T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 0,
//     "slas": [
//       // You can pass all the properties of the sla
//       {
//         "id": "Agendada",
//         "deliveryChannel": "delivery",
//         "availableDeliveryWindows": [
//           {
//             startDateUtc: '2018-05-26T09:00:00+00:00',
//             endDateUtc: '2018-05-26T21:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           },
//           {
//             startDateUtc: '2018-05-26T12:00:00+00:00',
//             endDateUtc: '2018-05-26T13:00:00+00:00',
//             price: 500,
//             lisPrice: 500,
//             tax: 0,
//           }
//         ]
//       }
//     ]
//   },
//   {
//     "addressId": "-4556418741084",
//     "selectedSla": null,
//     "selectedDeliveryChannel": null,
//     "shippingEstimate": "6bd",
//     "shippingEstimateDate": "2018-02-24T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 1,
//     "slas": [
//       { "id": "Normal", "deliveryChannel": "delivery" }
//     ]
//   }
// ]

params:

• logisticsInfo Type: Array<object> The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slas

returns:

• new logisticsInfo Type: Array<object> New logisticsInfo with selectedSla and selectedDeliveryChannel filled correctly on each item with slas that has availableDeliveryWindows

getNewLogisticsInfoWithScheduledDeliveryChoice (logisticsInfo, scheduledDeliveryChoice, scheduledDeliveryItems = null)

Get new logisticsInfo selecting the sla and delivery window passed and optionally filtering by a logistics items array.

Usage

const {
  getNewLogisticsInfoWithScheduledDeliveryChoice,
} = require('@vtex/delivery-packages/dist/shipping')

const logisticsInfo = [
  {
    // You can pass all the properties of the logisticsInfo
    addressId: '-4556418741084',
    selectedSla: null,
    selectedDeliveryChannel: null,
    shippingEstimate: '5bd',
    shippingEstimateDate: '2018-02-23T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 0,
    slas: [
      // You can pass all the properties of the sla
      {
        id: 'Agendada',
        deliveryChannel: 'delivery',
        availableDeliveryWindows: [
          {
            startDateUtc: '2018-05-26T09:00:00+00:00',
            endDateUtc: '2018-05-26T21:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
          {
            startDateUtc: '2018-05-26T12:00:00+00:00',
            endDateUtc: '2018-05-26T13:00:00+00:00',
            price: 500,
            lisPrice: 500,
            tax: 0,
          },
        ],
      },
    ],
  },
  {
    addressId: '-4556418741084',
    selectedSla: null,
    selectedDeliveryChannel: null,
    shippingEstimate: '6bd',
    shippingEstimateDate: '2018-02-24T19:01:07.0336412+00:00',
    deliveryChannel: 'delivery',
    itemIndex: 1,
    slas: [{ id: 'Normal', deliveryChannel: 'delivery' }],
  },
]

const deliveryWindow = {
  startDateUtc: '2018-05-26T12:00:00+00:00',
  endDateUtc: '2018-05-26T13:00:00+00:00',
  price: 500,
  lisPrice: 500,
  tax: 0,
}

getNewLogisticsInfoWithScheduledDeliveryChoice(
  logisticsInfo,
  { selectedSla: 'Agendada', deliveryWindow },
  [{ itemIndex: 0 }]
)
// -> [
//   {
//     // You can pass all the properties of the logisticsInfo
//     "addressId": "-4556418741084",
//     "selectedSla": 'Agendada',
//     "selectedDeliveryChannel": 'delivery',
//     "shippingEstimate": "5bd",
//     "shippingEstimateDate": "2018-02-23T19:01:07.0336412+00:00",
//     "deliveryChannel": "delivery",
//     "itemIndex": 0,
//     "deliveryWindow": {
//       startDateUtc: '2018-05-26T12:00:00+00:00',
//       endDateUtc: '2018-05-26T13:00:00+00:00',
//       price: 500,
//       lisPrice: 500,
//       tax: 0,
//     },
//     "slas": [
//       // You can pass all the properties of the sla
//       {
//         "id": "Agendada",
//         "deliveryChannel": "delivery",
//         "deliveryWindow": {
//           startDateUtc: '2018-05-26T12:00:00+00:00',
//           endDateUtc: '2018-05-26T13:00:00+00:00',
//           price: 500,
//           lisPrice: 500,
//           tax: 0,
//         },
//         "a