Skip to main content
GET
/
accounts
/
{aid}
/
shopping
/
draft_orders
Draft orders collection
curl --request GET \
  --url https://api.dintero.com/v1/accounts/{aid}/shopping/draft_orders \
  --header 'Authorization: Bearer <token>'
{
  "draft_orders": [
    {
      "order": {
        "currency": "NOK",
        "customer": {
          "first_name": "John",
          "last_name": "Doe",
          "id": "<string>",
          "gender": "male",
          "email": "customer@example.com",
          "metadata": {
            "dob_year": 1985
          },
          "phone_number": "+4799999999",
          "addresses": [
            {
              "address_line": "Sommerkroveien 34",
              "postal_place": "Oslo",
              "country": "NO",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "latitude": 59.942112,
              "longitude": 10.716991,
              "type": "<string>",
              "custom_type": "<string>"
            }
          ],
          "pays_tax": false,
          "date_of_birth": "1990-09-20",
          "enrolled_by": {
            "value": "https://facebook.com",
            "type": "url"
          },
          "favorite_store": "<string>",
          "company": {
            "bussiness_name": "TKP tech AS",
            "organization_number": "123456789MVA",
            "department": "sales department",
            "industry": "computer industry",
            "website": "<string>",
            "number_of_employees": "<string>"
          },
          "marketing_consent": {
            "sms": {
              "consent": true,
              "updated_at": "2018-01-12T13:42:00Z"
            },
            "email": {
              "consent": true,
              "updated_at": "2018-01-12T13:42:00Z"
            }
          },
          "status": "<string>",
          "term": {
            "id": "<string>"
          },
          "type": "customer"
        },
        "gross_amount": 59800,
        "net_amount": 47840,
        "total_discount": 23130,
        "total_manual_discount_amount": 0,
        "shipping_address": {
          "address_line": "Sommerkroveien 34",
          "postal_place": "Oslo",
          "country": "NO",
          "address_line_2": "PB 123",
          "postal_code": "0349",
          "latitude": 59.942112,
          "longitude": 10.716991,
          "first_name": "John",
          "last_name": "Doe",
          "comment": "5th floor, use doorbell."
        },
        "billing_address": {
          "address_line": "Sommerkroveien 34",
          "postal_place": "Oslo",
          "country": "NO",
          "address_line_2": "PB 123",
          "postal_code": "0349",
          "latitude": 59.942112,
          "longitude": 10.716991,
          "first_name": "John",
          "last_name": "Doe",
          "comment": "5th floor, use doorbell."
        },
        "metadata": {},
        "comment": "<string>",
        "salesperson_id": "<string>",
        "salesperson_name": "<string>",
        "delivery_at": "2023-11-07T05:31:56Z",
        "pickup_at": "2023-11-07T05:31:56Z",
        "courier_id": "<string>",
        "pre_order": true,
        "time_to_live": 94672800,
        "itinerary": [
          {
            "id": "<string>",
            "operator": "<string>",
            "arrival_address": {
              "id": "<string>",
              "name": "<string>",
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "latitude": 59.942112,
              "longitude": 10.716991,
              "country": "NO",
              "external_ids": [
                {
                  "id": "<string>",
                  "source": "<string>",
                  "description": "<string>"
                }
              ]
            },
            "arrival_at": "<string>",
            "departure_address": {
              "id": "<string>",
              "name": "<string>",
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "latitude": 59.942112,
              "longitude": 10.716991,
              "country": "NO",
              "external_ids": [
                {
                  "id": "<string>",
                  "source": "<string>",
                  "description": "<string>"
                }
              ]
            },
            "departure_at": "<string>",
            "travel_mode": "BUS",
            "route_id": "<string>",
            "vehicle_id": "<string>",
            "summary": "<string>",
            "distance": {
              "value": 123
            },
            "duration": {
              "value": 123
            },
            "tickets": [
              {
                "class": "<string>",
                "line": "<string>",
                "seat": "<string>",
                "zone": "<string>",
                "passenger_id": [
                  "<string>"
                ]
              }
            ],
            "line_ids": [
              123
            ],
            "waypoints": [
              {
                "latitude": 123,
                "longitude": 123,
                "display_name": "<string>",
                "arrival_schedule_at": "<string>",
                "departure_schedule_at": "<string>"
              }
            ]
          }
        ],
        "external_ids": [
          {
            "id": "<string>",
            "source": "<string>",
            "description": "<string>"
          }
        ],
        "items": [
          {
            "gross_amount": 39800,
            "tax_lines": [
              {
                "amount": 5584,
                "amount_dwh": "5584.0440",
                "exempt": false,
                "included_in_price": true,
                "percentage": 25,
                "tax_basis": 27920,
                "tax_basis_dwh": "27920.22",
                "tax_code": "3",
                "tax_group": "Vmva-høy"
              }
            ],
            "status": "<string>",
            "id": "175938",
            "metadata": {},
            "groups": [
              {
                "id": "B234",
                "name": "Stol"
              },
              {
                "id": "B1",
                "name": "Møbel"
              }
            ],
            "line_id": 1,
            "quantity": 2,
            "net_amount": 27840,
            "description": "Stablestol for utendørsbruk",
            "description_alias": "Staplestol",
            "is_changed": false,
            "eligible_for_discount": true,
            "dimension": {
              "color": "<string>",
              "size": "<string>",
              "style": "<string>",
              "config": "<string>",
              "variant": "<string>"
            },
            "discount_lines": [
              {
                "amount": 23130,
                "percentage": 10,
                "discount_type": "customer",
                "discount_subtype": "campaign-periode-q3",
                "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
                "description": "<string>",
                "line_id": 1
              }
            ],
            "additions": [
              {
                "id": "C1203",
                "description": "Extra Cheese",
                "quantity": 1,
                "gross_amount": 1000,
                "groups": [
                  {
                    "id": "B234",
                    "name": "Stol"
                  },
                  {
                    "id": "B1",
                    "name": "Møbel"
                  }
                ]
              }
            ],
            "store": {
              "id": "SL02",
              "organization_number": "123456789MVA",
              "name": "SC Oslo",
              "business_name": "SC Oslo AS",
              "comment": "<string>"
            },
            "external_id": "SL02-94821948",
            "related_item": {
              "line_id": 123,
              "type": "required"
            },
            "salesperson_id": "<string>",
            "salesperson_name": "<string>",
            "comment": "<string>",
            "version": 123,
            "reversed_reason": "<string>",
            "dynamic_payout": {
              "rule_type": "<string>",
              "rule_id": "<string>"
            },
            "payout": {
              "destinations": [
                {
                  "type": "percentage",
                  "value": "10",
                  "amount": 4000,
                  "destinations": [
                    {
                      "amount": 500
                    },
                    {
                      "destinations": [
                        {
                          "amount": 3500
                        }
                      ]
                    }
                  ]
                },
                {
                  "amount": 500
                },
                {
                  "destinations": [
                    {
                      "amount": 192
                    },
                    {
                      "amount": 38308
                    }
                  ]
                }
              ]
            },
            "original_currency": "SEK",
            "original_gross_amount": 39800,
            "conversion_rate_ppm": 1099000,
            "conversion_rate_timestamp": "2023-11-07T05:31:56Z",
            "conversion_rate_source": "ecb"
          }
        ],
        "version": 123,
        "type": "delivery",
        "order_number": "order123456",
        "order_id": "<string>",
        "time_to_live_expires_at": "<string>",
        "multiple_authorizations": true,
        "discounts": [
          {
            "id": "<string>",
            "refs": [
              {
                "id": "<string>",
                "amount": 123,
                "statistics": {
                  "amount": 123,
                  "stamp": 123,
                  "usage": 123
                },
                "stamp": 123,
                "usages": 123,
                "items": [
                  {
                    "line_id": 123,
                    "amount": 123
                  }
                ]
              }
            ]
          }
        ],
        "store": {
          "id": "SL02",
          "organization_number": "123456789MVA",
          "name": "SC Oslo",
          "business_name": "SC Oslo AS",
          "comments": [
            "<string>"
          ]
        },
        "external_links": [
          {
            "text": "Order Receipt",
            "href": "https://example.dintero.com/receipts/234CC019-8BA9-4DDB-9A40-8C9EE0BB943C?type=pdf",
            "public": true
          }
        ],
        "attachments": [
          {
            "id": "<string>",
            "bus_reservation": {
              "booking_id": "NE 138 47794",
              "line_ids": [
                123
              ],
              "passengers": [
                {
                  "id": "<string>",
                  "title": "<string>",
                  "first_name": "<string>",
                  "last_name": "<string>"
                }
              ],
              "itinerary": [
                {
                  "departure_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "departure_at": "2023-11-07T05:31:56Z",
                  "arrival_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "arrival_at": "2023-11-07T05:31:56Z",
                  "operator": "SAS",
                  "class": "<string>",
                  "line": "<string>",
                  "seat": "<string>",
                  "zone": "<string>",
                  "expires_at": "2023-11-07T05:31:56Z",
                  "activates_at": "2023-11-07T05:31:56Z",
                  "passenger_id": [
                    "<string>"
                  ]
                }
              ],
              "insurance": [
                {
                  "insurance_company": "<string>",
                  "insurance_type": "<string>"
                }
              ]
            },
            "car_reservation": {
              "booking_id": "TV 347794",
              "line_ids": [
                123
              ],
              "itinerary": [
                {
                  "rental_company": "Avis",
                  "drivers_id": [
                    "<string>"
                  ],
                  "pick_up_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "pick_up_at": "2023-11-07T05:31:56Z",
                  "drop_off_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "drop_off_at": "2023-11-07T05:31:56Z",
                  "class": "<string>"
                }
              ],
              "drivers": [
                "<string>"
              ],
              "insurance": [
                {
                  "insurance_company": "<string>",
                  "insurance_type": "<string>"
                }
              ]
            },
            "ferry_reservation": {
              "booking_id": "NE 138 47794",
              "line_ids": [
                123
              ],
              "passengers": [
                {
                  "id": "<string>",
                  "title": "<string>",
                  "first_name": "<string>",
                  "last_name": "<string>"
                }
              ],
              "itinerary": [
                {
                  "departure_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "departure_at": "2023-11-07T05:31:56Z",
                  "arrival_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "arrival_at": "2023-11-07T05:31:56Z",
                  "operator": "SAS",
                  "class": "<string>",
                  "line": "<string>",
                  "seat": "<string>",
                  "zone": "<string>",
                  "expires_at": "2023-11-07T05:31:56Z",
                  "activates_at": "2023-11-07T05:31:56Z",
                  "passenger_id": [
                    "<string>"
                  ]
                }
              ],
              "insurance": [
                {
                  "insurance_company": "<string>",
                  "insurance_type": "<string>"
                }
              ]
            },
            "metro_reservation": {
              "booking_id": "NE 138 47794",
              "line_ids": [
                123
              ],
              "passengers": [
                {
                  "id": "<string>",
                  "title": "<string>",
                  "first_name": "<string>",
                  "last_name": "<string>"
                }
              ],
              "itinerary": [
                {
                  "departure_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "departure_at": "2023-11-07T05:31:56Z",
                  "arrival_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "arrival_at": "2023-11-07T05:31:56Z",
                  "operator": "SAS",
                  "class": "<string>",
                  "line": "<string>",
                  "seat": "<string>",
                  "zone": "<string>",
                  "expires_at": "2023-11-07T05:31:56Z",
                  "activates_at": "2023-11-07T05:31:56Z",
                  "passenger_id": [
                    "<string>"
                  ]
                }
              ],
              "insurance": [
                {
                  "insurance_company": "<string>",
                  "insurance_type": "<string>"
                }
              ]
            },
            "taxi_reservation": {
              "booking_id": "NE 138 47794",
              "line_ids": [
                123
              ],
              "passengers": [
                {
                  "id": "<string>",
                  "title": "<string>",
                  "first_name": "<string>",
                  "last_name": "<string>"
                }
              ],
              "itinerary": [
                {
                  "departure_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "departure_at": "2023-11-07T05:31:56Z",
                  "arrival_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "arrival_at": "2023-11-07T05:31:56Z",
                  "operator": "SAS",
                  "class": "<string>",
                  "line": "<string>",
                  "seat": "<string>",
                  "zone": "<string>",
                  "expires_at": "2023-11-07T05:31:56Z",
                  "activates_at": "2023-11-07T05:31:56Z",
                  "passenger_id": [
                    "<string>"
                  ]
                }
              ],
              "insurance": [
                {
                  "insurance_company": "<string>",
                  "insurance_type": "<string>"
                }
              ]
            },
            "train_reservation": {
              "booking_id": "NE 138 47794",
              "line_ids": [
                123
              ],
              "passengers": [
                {
                  "id": "<string>",
                  "title": "<string>",
                  "first_name": "<string>",
                  "last_name": "<string>"
                }
              ],
              "itinerary": [
                {
                  "departure_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "departure_at": "2023-11-07T05:31:56Z",
                  "arrival_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "arrival_at": "2023-11-07T05:31:56Z",
                  "operator": "SAS",
                  "class": "<string>",
                  "line": "<string>",
                  "seat": "<string>",
                  "zone": "<string>",
                  "expires_at": "2023-11-07T05:31:56Z",
                  "activates_at": "2023-11-07T05:31:56Z",
                  "passenger_id": [
                    "<string>"
                  ]
                }
              ],
              "insurance": [
                {
                  "insurance_company": "<string>",
                  "insurance_type": "<string>"
                }
              ]
            },
            "tram_reservation": {
              "booking_id": "NE 138 47794",
              "line_ids": [
                123
              ],
              "passengers": [
                {
                  "id": "<string>",
                  "title": "<string>",
                  "first_name": "<string>",
                  "last_name": "<string>"
                }
              ],
              "itinerary": [
                {
                  "departure_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "departure_at": "2023-11-07T05:31:56Z",
                  "arrival_address": {
                    "address_line": "Sommerkroveien 34",
                    "postal_place": "Oslo",
                    "country": "NO",
                    "address_line_2": "PB 123",
                    "postal_code": "0349",
                    "latitude": 59.942112,
                    "longitude": 10.716991
                  },
                  "arrival_at": "2023-11-07T05:31:56Z",
                  "operator": "SAS",
                  "class": "<string>",
                  "line": "<string>",
                  "seat": "<string>",
                  "zone": "<string>",
                  "expires_at": "2023-11-07T05:31:56Z",
                  "activates_at": "2023-11-07T05:31:56Z",
                  "passenger_id": [
                    "<string>"
                  ]
                }
              ],
              "insurance": [
                {
                  "insurance_company": "<string>",
                  "insurance_type": "<string>"
                }
              ]
            }
          }
        ],
        "stores": [
          {
            "id": "SL02",
            "organization_number": "123456789MVA",
            "name": "SC Oslo",
            "business_name": "SC Oslo AS",
            "comments": [
              "<string>"
            ]
          }
        ]
      },
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "deleted_at": "2023-11-07T05:31:56Z",
      "status": "open",
      "_links": [
        {
          "href": "<string>",
          "rel": "draft"
        }
      ],
      "version": 123,
      "events": [
        {
          "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
          "version": 123,
          "request": {
            "path": "<string>",
            "method": "<string>",
            "body": "<string>"
          },
          "draft_id": "<string>"
        }
      ],
      "options": {
        "order_time_to_live": 94672800,
        "generate_order_id": "UUID",
        "order_id": "<string>",
        "replace": "order",
        "payout": {
          "resolve_rule_id": "order.items.store.id",
          "resolve_rule_type": "<string>",
          "rules": [
            {
              "rule_type": "order.items.store.id",
              "rule_id": "sc029",
              "destinations": [
                {
                  "type": "percentage",
                  "value": 10,
                  "destinations": [
                    {
                      "type": "flat_amount",
                      "value": "500",
                      "destination": "account-a"
                    },
                    {
                      "type": "remaining_amount",
                      "destinations": [
                        {
                          "type": "percentage",
                          "value": "5.0",
                          "destination": "account-b"
                        }
                      ]
                    }
                  ]
                },
                {
                  "type": "flat_amount",
                  "value": "500",
                  "destination": "account-a"
                },
                {
                  "type": "remaining_amount",
                  "destinations": [
                    {
                      "type": "percentage",
                      "value": "5",
                      "destination": "account-b"
                    },
                    {
                      "type": "percentage",
                      "value": "95.0",
                      "destination": "account-c"
                    }
                  ]
                }
              ],
              "account_id": "<string>",
              "rule_version": 1,
              "metadata": {}
            }
          ]
        },
        "split_draft": false,
        "serial_order_number_suffix": false,
        "multiple_authorizations": false
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.dintero.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication (token authentication) should be used for accessing the API.

Use Get Token to get an access token for client credentials. Pass the token in the request header:

Authorization: Bearer {access_token}

where the access_token is JSON Web Tokens (JWT).

Path Parameters

aid
string<^[PT]{1}\d{8}$>
required

An id that uniquely identifies the account.

Required string length: 9

Query Parameters

starting_after
string<uuid>

cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

limit
integer
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

Required range: 1 <= x <= 100
customer_id
string

The resource identifier string

status
enum<string>[]

filter by draft order status

Available options:
open,
completed,
deleted
created_at.gte
string<date>

filter by created_at, greater than or equal (after)

created_at.lte
string<date>

filter by created_at, less than or equal (before)

net_amount.gte
integer

Lower limit for filtering on order net_amount.

Required range: x >= 0
net_amount.lte
integer

Upper limit for filtering on order net_amount.

Required range: x >= 0
currency
string<iso-4217>[]

Filter on order currency (3-letter currency code)

Will try to match the search to either order_id, external_ids or customer phone_number, email, name or customer_id.

Response

draft order collection

draft_orders
object[]
required