@vtex/delivery-packages
Advanced tools
> Library of functions that help to separate items in parcels and select delivery items on UIs
Library of functions that help to separate items in parcels and select delivery items on UIs
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:
This module provides a consistent way to handle all those criteria.
And provide also helper functions for other use cases.
$ npm install @vtex/delivery-packages
Returns an array of Parcels.
An order shaped like an orderForm.
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.
@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]
}
The address used for that parcel. If it is a pickup point, the address of the pickup point is returned.
If the parcel is delivered to a pickup point, this field has its friendly name.
The items of the parcel.
The seller of the parcel.
The package object from packageAttachment, if it is one.
These properties are taken from the logisticsInfo of the parcel.
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"
// }
// ]
@vtex/delivery-packages/dist/address
Add property addressId with random hash string (uuid) if not present on address object passed
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:
object
An object containing all address fields like on availableAddresses of orderFormreturns:
object
An object containing all address fields like on availableAddresses of orderForm with an addressId includedAdd all addresses present on pickupSlas that are not already on addresses list
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:
Array<object>
An array which each item is an object containing all address fields like on availableAddresses of orderFormArray<object>
An array which each item is an object containing a list of slas of the pickup-in-point deliveryChannelreturns:
Array<object>
New list of addresses containing the pickup addressesFind a reference address index on addresses list according to the reference addressId or -1 if it doesn't find it
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:
Array<object>
An array which each item is an object containing all address fields like on availableAddresses of orderFormobject
An object with addressId reference to be used to searchreturns:
number
Position on addresses of the searchAddress reference according to its addressIdFind a reference address on addresses list according to the reference addressId or null if it doesn't find it
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:
Array<object>
An array which each item is an object containing all address fields like on availableAddresses of orderFormobject
An object with addressId reference to be used to searchreturns:
object
The address foundWorks like findAddress above but the searchAddress postalCode property is used instead
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: [],
// }
Verify address has all required basic fields
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:
boolean
If the address has all required fieldsVerify address refers to a pickup point
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:
object
An object containing all address fields like on availableAddresses of orderFormreturns:
boolean
If the address refers to a pickup pointVerify address refers to a residential address (to deliver items)
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:
object
An object containing all address fields like on availableAddresses of orderFormreturns:
boolean
If the address refers to a residential address (to deliver items)Verify address refers to a gift list address
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:
object
An object containing all address fields like on availableAddresses of orderFormreturns:
boolean
If the address refers to a gift list addressFilter only residential and complete address
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:
Array<object>
An array which each item is an object containing all address fields like on availableAddresses of orderFormreturns:
Array<object>
Filtered addresses that contain only residential and complete addressCreate an object where each key is an address type and each value is an array of addresses grouped by each address type
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:
Array<object>
An array which each item is an object containing all address fields like on selectedAddresses of orderFormreturns:
object
An object where each key is an address type and each value is an array of addresses grouped by each address typeAdds new address if the addressType of newAddress is not found or replace an existing address of that type
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:
Array<object>
An array which each item is an object containing all address fields like on selectedAddresses of orderFormstring
New address to be included on the list of addressesreturns:
object
New list of addresses with the newAddress includedAdds new address if the newAddress is not found or replace an existing address with the same addressId
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:
Array<object>
An array which each item is an object containing all address fields like on selectedAddresses of orderFormstring
New address to be included on the list of addressesreturns:
object
New list of addresses with the newAddress includedAdds 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.
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:
Array<object>
An array which each item is an object containing all address fields like on selectedAddresses of orderFormobject
New address to be included on the list of addressesreturns:
Array<object>
New list of addresses with the newAddress included@vtex/delivery-packages/dist/delivery-channel
Get the delivery channel string of a delivery channel source.
const {
getDeliveryChannel,
} = require('@vtex/delivery-packages/dist/delivery-channel')
getDeliveryChannel({ id: 'pickup-in-point' })
// -> 'pickup-in-point'
params:
object or string
An object containing a deliveryChannel string or the string itselfreturns:
string
The deliveryChannel string (generally 'pickup-in-point' or 'delivery')Check if the delivery channel source is a pickup point.
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:
object or string
An object containing a deliveryChannel string or the string itselfreturns:
boolean
true or falseCheck if the delivery channel source is a delivery.
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:
object or string
An object containing a deliveryChannel string or the string itselfreturns:
boolean
true or falseSearch for a delivery channel object from an object container a list of delivery channel objects (usually it will be a logisticsInfo item).
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:
object
An object containing a deliveryChannels arrayobject or string
An object containing a deliveryChannel string or the string itselfreturns:
object
Object like { id: 'delivery' } or { id: 'pickup-in-point' }@vtex/delivery-packages/dist/items
Get new items based on the ones passed and an array of changes.
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:
Array<object>
New array of items with the changes appliedMerge items with packages and organize them based if they were already delivered or will be delivered.
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:
object
Object on the format { items, packages } containing the items and packages of an order, with the index of each item and packagereturns:
object
Object contained the keys delivered and toBeDelivered containing the right items and packagesReturn multiple values with information about the items indexes
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:
Array<object>
Array of items with itemIndex keys like the logisticsInfo of the orderFormreturns:
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
@vtex/delivery-packages/dist/scheduled-delivery
Check if two available delivery windows are equal.
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:
boolean
true or falseGet new logisticsInfo with the deliveryWindow of the selectedSla inserted.
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:
Array<object>
The new logisticsInfo with the deliveryWindow selected on the matching items that have the selectedSla passedGet the first sla with scheduled delivery matching the availableDeliveryWindows passed.
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:
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@vtex/delivery-packages/dist/shipping
Get new logisticsInfo with the selectedSla on all items that can receive it as selected.
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:
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 slasGet new logisticsInfo selecting first sla that has availableDeliveryWindows on each item that can be scheduled delivered.
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:
Array<object>
The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slasreturns:
Array<object>
New logisticsInfo with selectedSla and selectedDeliveryChannel filled correctly on each item with slas that has availableDeliveryWindowsGet new logisticsInfo selecting the sla and delivery window passed and optionally filtering by a logistics items array.
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,
// },
// "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:
Array<object>
The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slasobject
An object like { selectedSla, deliveryWindow } saying what sla and deliveryWindow to choose the deliveryArray<object>
An array of objects, each like { itemIndex: number } or { index: number } so that you can filter what items should change their selected sla and delivery windowreturns:
Array<object>
New logisticsInfo with selectedSla, selectedDeliveryChannel and deliveryWindow filled correctly according to the paramsGet new logisticsInfo filtered by filters object and optionally choosing if the missing items are maintained on the new array as null values, to keep the original size.
On each criteria, like in the items filter, the algorithm is to include everything that match any item filter (using an || logic).
const { filterLogisticsInfo } = require('@vtex/delivery-packages/dist/shipping')
const logisticsInfo = [
{
// You can pass all the properties of the logisticsInfo
addressId: '-4556418741084',
selectedSla: null,
selectedDeliveryChannel: null,
shippingEstimate: '1bd',
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' },
],
},
{
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 items = [{ index: 0 }] // or const items = [{ itemIndex: 0 }, { itemIndex: 2 }]
filterLogisticsInfo(logisticsInfo, { items })
// -> [
// {
// // You can pass all the properties of the logisticsInfo
// "addressId": "-4556418741084",
// "selectedSla": null,
// "selectedDeliveryChannel": null,
// "shippingEstimate": "1bd",
// "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"}
// ]
// }
// ]
const keepSize = true
filterLogisticsInfo(logisticsInfo, { items }, keepSize)
// -> [
// {
// // You can pass all the properties of the logisticsInfo
// "addressId": "-4556418741084",
// "selectedSla": null,
// "selectedDeliveryChannel": null,
// "shippingEstimate": "1bd",
// "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"}
// ]
// },
// null
// ]
params:
Array<object>
The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slasobject
An object like { items: [{ index or itemIndex: number }, ...], } saying what items to filter on logisticsInfoboolean
Flag to inform if the missing items are maintained on the new array as null values, to keep the original size, or they are just removed (default)returns:
Array<object>
New logisticsInfo filtered by the filters param and with the size according to keepSize paramGet new logisticsInfo and selectedAddresses making sure all pickup addresses that are on a selectedSla are included on selectedAddresses list and then making sure all logisticsInfo items have addressIds matching the ones on selectedAddresses.
const { getNewLogisticsMatchingSelectedAddresses } = require('@vtex/delivery-packages/dist/shipping')
const logisticsInfo = [
{
// You can pass all the properties of the logisticsInfo
"addressId": "-4556418741084",
"selectedSla": "MeuPickupPoint",
"selectedDeliveryChannel": "pickup-in-point",
"itemIndex": 0,
"slas": [
{
"id": "MeuPickupPoint",
"deliveryChannel": "pickup-in-point",
"name": "VTEX RJ (1b4e9b2)",
"shippingEstimate": "0bd",
"price": 0,
"pickupPointId": "1_1b4e9b2",
"pickupStoreInfo": {
"isPickupStore": true,
"friendlyName": "VTEX RJ",
"address": {
"addressType": "pickup",
"receiverName": null,
"addressId": "1b4e9b2",
"postalCode": "22250040",
"city": "Rio de Janeiro",
"state": "RJ",
"country": "BRA",
"street": "Praia de Botafogo",
"number": "300",
"neighborhood": "Botafogo",
"complement": "",
"reference": null,
"geoCoordinates": [-43.1822662, -22.9459858]
}
}
}
]
},
{
"addressId": null,
"selectedSla": "Normal",
"selectedDeliveryChannel": "delivery",
"itemIndex": 1,
"slas": [
// You can pass all the properties of the sla
{ "id": "Normal", "deliveryChannel": "delivery" }
]
}
]
const selectedAddresses = [{
"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": [],
}]
getNewLogisticsMatchingSelectedAddresses(logisticsInfo, selectedAddresses)
// -> {
// logisticsInfo: [{
// "addressId": "1b4e9b2",
// "selectedSla": "MeuPickupPoint",
// "selectedDeliveryChannel": "pickup-in-point",
// "itemIndex": 0,
// "slas": [
// {
// "id": "MeuPickupPoint",
// "deliveryChannel": "pickup-in-point",
// "name": "VTEX RJ (1b4e9b2)",
// "shippingEstimate": "0bd",
// "price": 0,
// "pickupPointId": "1_1b4e9b2",
// "pickupStoreInfo": {
// "isPickupStore": true,
// "friendlyName": "VTEX RJ",
// "address": {
// "addressType": "pickup",
// "receiverName": null,
// "addressId": "1b4e9b2",
// "postalCode": "22250040",
// "city": "Rio de Janeiro",
// "state": "RJ",
// "country": "BRA",
// "street": "Praia de Botafogo",
// "number": "300",
// "neighborhood": "Botafogo",
// "complement": "",
// "reference": null,
// "geoCoordinates": [-43.1822662, -22.9459858]
// }
// }
// }
// ]
// },
// {
// "addressId": "-4556418741084",
// "selectedSla": "Normal",
// "selectedDeliveryChannel": "delivery",
// "itemIndex": 1,
// "slas": [
// { "id": "Normal", "deliveryChannel": "delivery" }
// ]
// }],
// selectedAddresses: [{
// "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": [],
// }, {
// "addressType": "pickup",
// "receiverName": null,
// "addressId": "1b4e9b2",
// "postalCode": "22250040",
// "city": "Rio de Janeiro",
// "state": "RJ",
// "country": "BRA",
// "street": "Praia de Botafogo",
// "number": "300",
// "neighborhood": "Botafogo",
// "complement": "",
// "reference": null,
// "geoCoordinates": [-43.1822662, -22.9459858]
// }]
// }
params:
Array<object>
The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slasArray<object>
The selectedAddresses like the one inside orderForm.shippingData with address objects that are related to the order
returns:{ logisticsInfo: Array<object>, selectedAddresses: Array<object> }
New logisticsInfo and selectedAddresses with matching addressIds and with all pickup addresses includedGet new logisticsInfo with the merged items from logisticsInfo1 and logisticsInfo2
const { mergeLogisticsInfos } = require('@vtex/delivery-packages/dist/shipping')
const logisticsInfo1 = [
{
// You can pass all the properties of the logisticsInfo
"itemIndex": 0,
"selectedSla": "sla1",
},
{
// You can pass all the properties of the logisticsInfo
"itemIndex": 2,
"selectedSla": "sla3",
}
]
const logisticsInfo2 = [
{
// You can pass all the properties of the logisticsInfo
"itemIndex": 1,
"selectedSla": "sla2",
}
]
mergeLogisticsInfos(logisticsInfo1, logisticsInfo2)
// -> [
// {
// "itemIndex": 0,
// "selectedSla": "sla1",
// },
// {
// "itemIndex": 1,
// "selectedSla": "sla2",
// },
// {
// "itemIndex": 2,
// "selectedSla": "sla3",
// },
// ]
params:
Array<object>
The logisticsInfo like the one inside orderForm.shippingData with itemIndexArray<object>
The logisticsInfo like the one inside orderForm.shippingData with itemIndex
returns:Array<object>
Return all items of logisticsInfo2 completing its missing items from the logisticsInfo1 (merge operation)@vtex/delivery-packages/dist/sla
Check if the object or array passed have one or more slas
const { hasSLAs } = require('@vtex/delivery-packages/dist/sla')
hasSLAs({
slas: [
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
],
})
// -> true
hasSLAs([
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
])
// -> true
hasSLAs({ slas: [] })
// -> false
params:
object or Array<object>
Object with slas key or array of objectsreturns:
boolean
true or falseCheck if the object or array passed have at least of sla that can be scheduled delivered.
const { hasDeliveryWindows } = require('@vtex/delivery-packages/dist/sla')
hasDeliveryWindows([
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
])
// -> false
hasDeliveryWindows([
{
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,
},
],
},
{ id: 'Expressa', deliveryChannel: 'delivery' },
])
// -> true
hasDeliveryWindows({
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,
},
],
})
// -> true
params:
object or Array<object>
Object with a single sla or an array of slasreturns:
boolean
true or falseReturn only delivery slas from a list of slas passed.
const {
excludePickupTypeFromSlas,
} = require('@vtex/delivery-packages/dist/sla')
excludePickupTypeFromSlas([
{ id: 'Normal', deliveryChannel: 'delivery' },
{
id: 'Pickup',
deliveryChannel: 'delivery',
pickupStoreInfo: { isPickupStore: true, friendlyName: 'Shopping da Gávea' },
},
])
// -> [ { "id": "Normal", "deliveryChannel": "delivery" } ]
params:
Array<object>
An array of slasreturns:
Array<object>
An array with only the delivery slas (no pickup point sla)Get the sla object on slas that match the slaId passed.
const { getSlaObj } = require('@vtex/delivery-packages/dist/sla')
getSlaObj(
[
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
],
'Normal'
)
// -> { "id": "Normal", "deliveryChannel": "delivery" }
getSlaObj(
[
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
],
'Agendada'
)
// -> null
params:
slas
Type: Array<object>
An array of slas
slaId
Type: string
The id of a sla of the list passed
returns:
object
the sla object on the array that match the slaId passed or null if it doesn't find itGet the sla type (delivery, pickup-in-point or take-away) based on the sla deliveryChannel and if order is checkedIn
const { getSlaType } = require('@vtex/delivery-packages/dist/sla')
getSlaType(
{ id: 'Normal', deliveryChannel: 'delivery' }
)
// -> "delivery"
getSlaType(
{ id: 'Pickup', deliveryChannel: 'pickup-in-point' }
)
// -> "pickup-in-point"
getSlaType(
{ id: 'Pickup checked In', deliveryChannel: 'pickup-in-point', pickupPointId: '1_2' },
{ orderId: '123', checkedInPickupPointId: '1_2' }
)
// -> "take-away"
params:
sla
Type: object
An sla object
order
Type: object
An optional order object with the checkedInPickupPointId information
returns:
string
the sla type (delivery, pickup-in-point or take-away)Change logisticsInfoItem info to match the sla passed
const { changeSelectedSla } = require('@vtex/delivery-packages/dist/sla')
changeSelectedSla(
// Pode passar qualquer outra propriedade de um logisticsInfo item
{ "itemIndex": 0, "selectedSla": "Pickup", "selectedDeliveryChannel": "pickup-in-point" },
{ "id": "Normal", "deliveryChannel": "delivery" }
)
// -> { "itemIndex": 0, "selectedSla": "Normal", "selectedDeliveryChannel": "delivery" }
params:
object
An object like the ones on logisticsInfo of the orderFormobject
An object like the ones on logisticsInfoItem.slasreturns:
object
The new logisticsInfoItem with the selectedSla infos changed to match the sla paramGet the select sla object on logisticsInfo at the itemIndex position and optionally passing another selectedSla as reference.
const { getSelectedSla } = require('@vtex/delivery-packages/dist/sla')
getSelectedSla({
logisticsInfo: [
{
// other logisticsInfo properties can be passed also
selectedSla: 'Normal',
slas: [
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
],
},
{
// other logisticsInfo properties can be passed also
selectedSla: 'Expressa',
slas: [
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
],
},
],
itemIndex: 0,
})
// -> { "id": "Normal", "deliveryChannel": "delivery" }
getSelectedSla({
logisticsInfo: [
{
// other logisticsInfo properties can be passed also
selectedSla: 'Normal',
slas: [
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
],
},
{
// other logisticsInfo properties can be passed also
selectedSla: 'Expressa',
slas: [
{ id: 'Normal', deliveryChannel: 'delivery' },
{ id: 'Expressa', deliveryChannel: 'delivery' },
],
},
],
itemIndex: 1,
selectedSla: 'Normal',
})
// -> { "id": "Normal", "deliveryChannel": "delivery" }
params:
object
Object on the format {logisticsInfo, itemIndex, selectedSla} with logisticsInfo being an object like the one inside an orderForm, itemIndex a number referring the position of a logisticsInfo item and selectedSla an optional string with the id of the wanted slareturns:
object
the selectedSla object on the logisticsInfo item that itemIndex refers and optionally using another selectedSla then the one on logisticsInfo itemGet all selected slas objects on logisticsInfo.
const { getSelectedSlas } = require('@vtex/delivery-packages/dist/sla')
let logisticsInfo = [
{
// other logisticsInfo properties can be passed also
selectedSla: 'Normal',
itemIndex: 0,
slas: [
{ "id": "Normal", "deliveryChannel": "delivery" }, { "id": "Expressa", "deliveryChannel": "delivery" }
]
},
{
// other logisticsInfo properties can be passed also
selectedSla: 'Expressa',
itemIndex: 1,
slas: [
{ "id": "Normal", "deliveryChannel": "delivery" }, { "id": "Expressa", "deliveryChannel": "delivery" }
]
}
]
getSelectedSlas(logisticsInfo)
// -> [{ itemIndex: 0, "id": "Normal", "deliveryChannel": "delivery" }, { itemIndex: 1, "id": "Expressa", "deliveryChannel": "delivery" }]
logisticsInfo = [
{
// other logisticsInfo properties can be passed also
selectedSla: 'Normal',
itemIndex: 0,
slas: [
{ "id": "Normal", "deliveryChannel": "delivery" }, { "id": "Expressa", "deliveryChannel": "delivery" }
]
},
{
// other logisticsInfo properties can be passed also
selectedSla: null,
itemIndex: 1,
slas: [
{ "id": "Normal", "deliveryChannel": "delivery" }, { "id": "Expressa", "deliveryChannel": "delivery" }
]
}
]
getSelectedSlas(logisticsInfo)
// -> [{ itemIndex: 0, "id": "Normal", "deliveryChannel": "delivery" }, null]
params:
Array<object>
The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slasreturns:
Array<object>
the selected slas objects on the logisticsInfo items hydrated with itemIndex reference or empty array in case of wrong or empty params passedGet the selected slas objects on logisticsInfo filtered by pickup points type.
const { getPickupSelectedSlas } = require('@vtex/delivery-packages/dist/sla')
let logisticsInfo = [
{
// other logisticsInfo properties can be passed also
selectedSla: 'Normal',
itemIndex: 0,
slas: [
{ "id": "Normal", "deliveryChannel": "delivery" }, { "id": "Expressa", "deliveryChannel": "delivery" }
]
},
{
// other logisticsInfo properties can be passed also
selectedSla: 'Pickup',
itemIndex: 1,
slas: [
{ "id": "Normal", "deliveryChannel": "delivery" }, { "id": "Pickup", "deliveryChannel": "pickup-in-point" }
]
}
]
getPickupSelectedSlas(logisticsInfo)
// -> [{ "itemIndex": 1, "id": "Pickup", "deliveryChannel": "pickup-in-point" }]
params:
Array<object>
The logisticsInfo like the one inside orderForm.shippingData with selectedSla and slasreturns:
Array<object>
the selected slas objects on the logisticsInfo items hydrated with itemIndex reference and filtered by pickup type or empty array in case of wrong or empty params passedMIT © VTEX
FAQs
> Library of functions that help to separate items in parcels and select delivery items on UIs
The npm package @vtex/delivery-packages receives a total of 488 weekly downloads. As such, @vtex/delivery-packages popularity was classified as not popular.
We found that @vtex/delivery-packages demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 81 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Biden's executive order pushes for AI-driven cybersecurity, software supply chain transparency, and stronger protections for federal and open source systems.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.