Documentation

Address types overview

This document describes how Ingrid understands and handles different kind of addresses.

Dictionary

Examples

The package will be delivered to delivery_groups[0].addressess.customer
{
"session": {
"checkout_session_id": "VM2-ee41630a8f014198b40000cd88dcb984",
"status": "COMPLETE",
"updated_at": "2022-09-27T12:54:58Z",
"cart": {
"total_value": 10000,
"total_discount": 0,
"items": [
{
"sku": "6ee860fd-3ff8-4b69-b1a2-3e5db88851d5",
"name": "Keyboard",
"quantity": 1,
"price": 1000
}
],
"cart_id": "e1a0feda-ef31-4ddf-8721-c41a583332ca"
},
"delivery_groups": [
{
"items": [
{
"sku": "6ee860fd-3ff8-4b69-b1a2-3e5db88851d5"
}
],
"shipping": {
"delivery_type": "delivery",
"carrier": "PostNord",
"product": "MyPack Home",
"supports": {},
"warehouse": {
"address": {
"name": "Sweden",
"address_lines": [
"Sveavägen 21"
],
"city": "Stockholm",
"postal_code": "11222",
"country": "SE"
}
},
"carrier_product_id": "pnl-mph"
},
"category": {
"id": "cat1delivery-14493cdc1ae94f54acd13fe9cca57190",
"name": "Cat1Delivery",
"presented_category_name": "Cat1Delivery"
},
"pricing": {
"currency": "SEK",
"price": 2000,
"price_components": [
{
"type": "PRICE_COMPONENT_TYPE_SHIPPING",
"value": 2000
}
]
},
"selection": "PRESELECTED_CHOICE",
"delivery_time": {
"pickup_from_merchant": {
"earliest": "2022-09-28T00:00:00+02:00",
"latest": "2022-09-28T00:00:00+02:00"
},
"customer_delivery_promise": {
"earliest": "2022-09-29T21:00:00+02:00",
"latest": "2022-09-29T21:00:00+02:00"
},
"carrier_delivery_promise": {
"earliest": "2022-09-29T21:00:00+02:00",
"latest": "2022-09-29T21:00:00+02:00"
}
},
"tos_id": "01GDZG7JCQDRXXX9WFHANCSE5A",
"external_id": "1",
"addresses": {
"customer": {
"name": "Ingrid Tester",
"address_lines": [
"Jakobsgatan 11"
],
"city": "Stockholm",
"postal_code": "111 52",
"country": "SE",
"email": "test@ingrid.com"
},
"search_address": {
"address_lines": [
""
],
"country": "SE"
}
}
}
]
}
}
The package will be delivered to delivery_groups[0].addressess.location.address
{
"session": {
"checkout_session_id": "VM2-c6afee1afc304da7878d24c30597520c",
"status": "COMPLETE",
"updated_at": "2022-09-28T04:34:58Z",
"cart": {
"total_value": 10000,
"total_discount": 0,
"items": [
{
"sku": "0d0e4d91-3aca-4ff3-a109-2a9331e97f8f",
"name": "Keyboard",
"quantity": 1,
"price": 1000
}
],
"cart_id": "fcc8c37b-1aa2-47a4-a85b-ec2d0d81951e"
},
"delivery_groups": [
{
"items": [
{
"sku": "0d0e4d91-3aca-4ff3-a109-2a9331e97f8f"
}
],
"shipping": {
"delivery_type": "pickup",
"carrier": "Budbee",
"product": "Budbee Box",
"supports": {},
"warehouse": {
"address": {
"name": "Sweden",
"address_lines": [
"Sveavägen 21"
],
"city": "Stockholm",
"postal_code": "11222",
"country": "SE"
}
},
"carrier_product_id": "budbee-box"
},
"category": {
"id": "pickup-e22faa5e734a43149231509490d1c53c",
"name": "Pickup",
"presented_category_name": "Pickup"
},
"pricing": {
"currency": "SEK",
"price_components": [
{
"type": "PRICE_COMPONENT_TYPE_SHIPPING"
}
]
},
"selection": "USER_CHOICE",
"delivery_time": {
"pickup_from_merchant": {
"earliest": "2022-09-29T00:00:00+02:00",
"latest": "2022-09-29T00:00:00+02:00"
},
"customer_delivery_promise": {
"earliest": "2022-09-29T04:34:22Z",
"latest": "2022-09-29T04:34:22Z"
},
"carrier_delivery_promise": {
"earliest": "2022-09-29T04:34:22Z",
"latest": "2022-09-29T04:34:22Z"
}
},
"tos_id": "01GE160S068RX9QXXXRTM5CY6N",
"external_id": "1",
"addresses": {
"location": {
"external_id": "BOX0006",
"name": "Pressbyrån Rådhuset T-bana",
"address": {
"address_lines": [
"Bergsgatan 30"
],
"city": "Stockholm",
"postal_code": "11223",
"country": "SE",
"coordinates": {
"lat": 59.329811,
"lng": 18.04503
}
},
"distance": {
"walking": {
"value": 1222,
"duration": 14
},
"driving": {
"value": 1195,
"duration": 2
}
},
"operational_hours": {
"mon": "09:00-01:00",
"tue": "09:00-01:00",
"wed": "09:00-01:00",
"thu": "09:00-01:00",
"fri": "09:00-05:00",
"sat": "09:00-05:00",
"sun": "09:00-01:00"
},
"location_type": "LOCKER"
},
"customer": {
"name": "Ingrid Tester",
"address_lines": [
"Jakobsgatan 1"
],
"city": "Stockholm",
"postal_code": "111 52",
"country": "SE",
"email": "test@ingrid.com",
"phone": "1111111"
},
"search_address": {
"postal_code": "11152",
"country": "SE",
"coordinates": {
"lat": 59.32892497331362,
"lng": 18.06330357639328
}
}
}
}
]
}
}
Items from first delivery group will be delivered to delivery_groups[0].addressess.customer.

Items from second delivery goup will be delivered to delivery_groups[1].addressess.location.address.

To learn more about split shipment see Delivery Groups.

{
"session": {
"checkout_session_id": "VM2-2ddf0521833142ea9e6747d28b067c3e",
"status": "COMPLETE",
"updated_at": "2022-09-28T04:43:48Z",
"cart": {
"total_value": 10000,
"total_discount": 0,
"items": [
{
"sku": "0d0e4d91-3aca-4ff3-a109-2a9331e97f8f",
"name": "Keyboard",
"quantity": 1,
"price": 500
},
{
"sku": "fc07bfc2-5593-4234-baa2-8aa3f4c23250",
"name": "Headset",
"dimensions": {},
"quantity": 1,
"price": 500
}
],
"cart_id": "fcc8c37b-1aa2-47a4-a85b-ec2d0d81951e"
},
"delivery_groups": [
{
"header": "Delivery",
"items": [
{
"sku": "0d0e4d91-3aca-4ff3-a109-2a9331e97f8f"
}
],
"shipping": {
"delivery_type": "delivery",
"carrier": "PostNord",
"product": "MyPack Home",
"supports": {},
"warehouse": {
"address": {
"name": "Sweden",
"address_lines": [
"Sveavägen 21"
],
"city": "Stockholm",
"postal_code": "11222",
"country": "SE"
}
},
"carrier_product_id": "pnl-mph"
},
"category": {
"id": "cat1delivery-14493cdc1ae94f54acd13fe9cca57190",
"name": "Cat1Delivery",
"presented_category_name": "Cat1Delivery"
},
"pricing": {
"currency": "SEK",
"price": 2000,
"price_components": [
{
"type": "PRICE_COMPONENT_TYPE_SHIPPING",
"value": 2000
}
]
},
"selection": "PRESELECTED_CHOICE",
"delivery_time": {
"pickup_from_merchant": {
"earliest": "2022-09-29T00:00:00+02:00",
"latest": "2022-09-29T00:00:00+02:00"
},
"customer_delivery_promise": {
"earliest": "2022-09-30T21:00:00+02:00",
"latest": "2022-09-30T21:00:00+02:00"
},
"carrier_delivery_promise": {
"earliest": "2022-09-30T21:00:00+02:00",
"latest": "2022-09-30T21:00:00+02:00"
}
},
"tos_id": "01GE16GYDGD8W7F2RS3B7N6SBN",
"external_id": "1",
"group_id": "6eff8661-279b-43ae-bec8-b762fc3c4f9e",
"addresses": {
"customer": {
"name": "Ingrid Tester",
"address_lines": [
"Jakobsgatan 11"
],
"city": "Stockholm",
"postal_code": "111 52",
"country": "SE",
"email": "test@ingrid.com"
},
"search_address": {
"postal_code": "11152",
"country": "SE",
"coordinates": {
"lat": 59.32892497331362,
"lng": 18.06330357639328
}
}
}
},
{
"header": "Delivery",
"items": [
{
"sku": "fc07bfc2-5593-4234-baa2-8aa3f4c23250"
}
],
"shipping": {
"delivery_type": "pickup",
"carrier": "Budbee",
"product": "Budbee Box",
"supports": {},
"warehouse": {
"address": {
"name": "Sweden",
"address_lines": [
"Sveavägen 21"
],
"city": "Stockholm",
"postal_code": "11222",
"country": "SE"
}
},
"carrier_product_id": "budbee-box"
},
"category": {
"id": "pickup-e22faa5e734a43149231509490d1c53c",
"name": "Pickup",
"presented_category_name": "Pickup"
},
"pricing": {
"currency": "SEK",
"price_components": [
{
"type": "PRICE_COMPONENT_TYPE_SHIPPING"
}
]
},
"selection": "USER_CHOICE",
"delivery_time": {
"pickup_from_merchant": {
"earliest": "2022-09-29T00:00:00+02:00",
"latest": "2022-09-29T00:00:00+02:00"
},
"customer_delivery_promise": {
"earliest": "2022-09-29T04:43:05Z",
"latest": "2022-09-29T04:43:05Z"
},
"carrier_delivery_promise": {
"earliest": "2022-09-29T04:43:05Z",
"latest": "2022-09-29T04:43:05Z"
}
},
"tos_id": "01GE16GYDGMSYAQ5XXX9KDTE38",
"external_id": "1",
"group_id": "05470990-9fcd-4f39-b32f-b429518ed4f0",
"addresses": {
"location": {
"external_id": "BOX0007",
"name": "Pressbyrån Gallerian",
"address": {
"address_lines": [
"Hamngatan 37"
],
"city": "Stockholm",
"postal_code": "11153",
"country": "SE",
"coordinates": {
"lat": 59.331216,
"lng": 18.067468
}
},
"distance": {
"walking": {
"value": 406,
"duration": 4
},
"driving": {
"value": 741,
"duration": 1
}
},
"operational_hours": {
"mon": "09:00-01:00",
"tue": "09:00-01:00",
"wed": "09:00-01:00",
"thu": "09:00-01:00",
"fri": "09:00-05:00",
"sat": "09:00-05:00",
"sun": "09:00-01:00"
},
"location_type": "LOCKER"
},
"customer": {
"name": "Ingrid Tester",
"address_lines": [
"Jakobsgatan 11"
],
"city": "Stockholm",
"postal_code": "111 52",
"country": "SE",
"email": "test@ingrid.com"
},
"search_address": {
"postal_code": "11152",
"country": "SE",
"coordinates": {
"lat": 59.32892497331362,
"lng": 18.06330357639328
}
}
}
}
]
}
}
The package will be delivered to delivery_groups[0].addressess.delivery_address.

For payments delivery_groups[0].addressess.billing_address should be used.

To learn more about address form see Address Form.

{
"session": {
"checkout_session_id": "VM2-ff72484941dd46269f8b8f939587aea9",
"status": "COMPLETE",
"updated_at": "2022-09-28T04:55:09Z",
"cart": {
"total_value": 10000,
"total_discount": 0,
"items": [
{
"sku": "8ef1a5ee-4004-48c0-a7fc-f0ab5877711d",
"name": "Keyboard",
"quantity": 1,
"price": 1000
}
],
"cart_id": "7bb2774b-bb04-4d43-bb9a-1b67e628ccb7"
},
"delivery_groups": [
{
"items": [
{
"sku": "8ef1a5ee-4004-48c0-a7fc-f0ab5877711d"
}
],
"shipping": {
"delivery_type": "delivery",
"carrier": "Airmee",
"product": "Airmee",
"supports": {},
"warehouse": {
"address": {
"name": "Main Warehouse",
"address_lines": [
"Sveavägen 21"
],
"city": "Stockholm",
"postal_code": "112 22",
"country": "SE"
}
},
"carrier_product_id": "air"
},
"category": {
"id": "delivery-9892c6c022b948138d7e52128b44bc07",
"name": "Delivery",
"presented_category_name": "Delivery"
},
"pricing": {
"currency": "SEK",
"price": 2000,
"price_components": [
{
"type": "PRICE_COMPONENT_TYPE_SHIPPING",
"value": 2000
}
]
},
"selection": "PRESELECTED_CHOICE",
"delivery_time": {
"pickup_from_merchant": {
"earliest": "2022-09-29T00:00:00+02:00",
"latest": "2022-09-29T00:00:00+02:00"
},
"customer_delivery_promise": {
"earliest": "2022-09-29T17:00:00+02:00",
"latest": "2022-09-29T22:00:00+02:00"
},
"carrier_delivery_promise": {
"earliest": "2022-09-29T17:00:00+02:00",
"latest": "2022-09-29T22:00:00+02:00"
}
},
"tos_id": "01GE175QCVXXX848GW2RVW7ZA9",
"external_id": "1",
"addresses": {
"delivery_address": {
"name": "Home",
"address_lines": [
"Torsgatan 2, 1"
],
"city": "Stockholm",
"postal_code": "11123",
"country": "SE",
"coordinates": {
"lat": 59.33589187658624,
"lng": 18.051930502670803
},
"street": "Torsgatan",
"street_number": "2",
"apartment_number": "1",
"email": "home@ingrid.com",
"phone": "+461231231"
},
"billing_address": {
"name": "Home",
"address_lines": [
"Torsgatan 2, 1"
],
"city": "Stockholm",
"postal_code": "11123",
"country": "SE",
"street": "Torsgatan",
"street_number": "2",
"apartment_number": "1",
"email": "home@ingrid.com",
"phone": "+461231231"
},
"search_address": {
"country": "SE"
}
}
}
]
}
}

Last updated: Thu, Dec 08, 06:15 AM