Skip to main content
POST
/
accounts
/
{aid}
/
shopping
/
orders
/
{order_id}
/
open
Open order
curl --request POST \
  --url https://api.dintero.com/v1/accounts/{aid}/shopping/orders/{order_id}/open \
  --header 'Authorization: Bearer <token>'
{
  "currency": "NOK",
  "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>"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_at": "2023-11-07T05:31:56Z",
  "cancelled_reason": "customer",
  "cancelled_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "closed_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "closed_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "payment_status": "pending",
  "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,
  "payment_details": {
    "remaining_capture_amount": 27840,
    "remaining_refund_amount": 27840,
    "remaining_cancellation_amount": 27840,
    "amount_due": 27840,
    "remaining_authorization_amount": 27840
  },
  "sessions": [
    {
      "items": [
        {
          "line_id": "<string>",
          "amount": 27840
        }
      ],
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "processed_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "_links": [
        {
          "href": "<string>",
          "rel": "draft"
        }
      ]
    }
  ],
  "authorizations": [
    {
      "items": [
        {
          "amount": 27840,
          "line_id": 123,
          "payout": {
            "rule_id": "<string>",
            "rule_type": "<string>",
            "destinations": [
              {
                "destination": "<string>",
                "amount": 123
              }
            ]
          }
        }
      ],
      "processed_at": "2023-11-07T05:31:56Z",
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_id": "<string>",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa",
          "metadata": {}
        }
      },
      "metadata": {},
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "success": true,
      "_links": [
        {
          "href": "<string>",
          "rel": "draft"
        }
      ],
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "captures": [
    {
      "items": [
        {
          "amount": 27840,
          "line_id": 123,
          "payout": {
            "rule_id": "<string>",
            "rule_type": "<string>",
            "destinations": [
              {
                "destination": "<string>",
                "amount": 123
              }
            ]
          }
        }
      ],
      "processed_at": "2023-11-07T05:31:56Z",
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_id": "<string>",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa",
          "metadata": {}
        }
      },
      "metadata": {},
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "success": true,
      "_links": [
        {
          "href": "<string>",
          "rel": "draft"
        }
      ],
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "refunds": [
    {
      "items": [
        {
          "amount": 27840,
          "line_id": 123,
          "payout": {
            "rule_id": "<string>",
            "rule_type": "<string>",
            "destinations": [
              {
                "destination": "<string>",
                "amount": 123
              }
            ]
          }
        }
      ],
      "processed_at": "2023-11-07T05:31:56Z",
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_id": "<string>",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa",
          "metadata": {}
        }
      },
      "metadata": {},
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "success": true,
      "_links": [
        {
          "href": "<string>",
          "rel": "draft"
        }
      ],
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "cancellations": [
    {
      "items": [
        {
          "amount": 27840,
          "line_id": 123,
          "payout": {
            "rule_id": "<string>",
            "rule_type": "<string>",
            "destinations": [
              {
                "destination": "<string>",
                "amount": 123
              }
            ]
          }
        }
      ],
      "processed_at": "2023-11-07T05:31:56Z",
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_id": "<string>",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa",
          "metadata": {}
        }
      },
      "metadata": {},
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "success": true,
      "_links": [
        {
          "href": "<string>",
          "rel": "draft"
        }
      ],
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "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>"
          }
        ]
      }
    }
  ],
  "comments": [
    {
      "body": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
      "deleted_at": "2023-11-07T05:31:56Z",
      "visibility": "private"
    }
  ],
  "delivery_id": "<string>",
  "_links": [
    {
      "href": "<string>",
      "rel": "draft"
    }
  ],
  "state": "<string>"
}

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
​
order_id
string
required

The resource identifier string

Query Parameters

​
include_events
enum<string>[]

include order events in response

Available options:
false,
true,
api-event,
service-event

Response

order

​
currency
string<iso-4217>
required

The tree-character ISO-4217 currency

Maximum string length: 3
Example:

"NOK"

​
events
(Api Event · object | Order Status Event · object)[]
required
​
id
string<uuid>
read-only

An UUID that uniquely identifies the resource

​
created_at
string<date-time>
read-only

The date-time when the resource was created

​
created_by
string
read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

​
updated_at
string<date-time>
read-only

The date-time when the resource was last updated

​
deleted_by
string
read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

​
deleted_at
string<date-time>
read-only
​
cancelled_reason
any

The reason why the order was canceled.

  • customer: The customer cancelled the order
  • declined: The payment was declined
  • other: Any reson
Example:

"customer"

​
cancelled_by
string

The ID of the user/client that cancelled the order

Maximum string length: 40
Example:

"bd04c959-d159-49b4-a096-2d84e014a8da"

​
cancelled_at
string<date-time>
read-only

The date and time ( ISO 8601 format) when the order was canceled.

​
closed_by
string

The ID of the user/client that cancelled the order

Maximum string length: 40
Example:

"bd04c959-d159-49b4-a096-2d84e014a8da"

​
closed_at
string<date-time>

The date and time ( ISO 8601 format) when the order was canceled.

​
status
enum<string>
default:open
read-only

Order status

Available options:
open,
closed,
cancelled
​
payment_status
enum<string>
default:pending
read-only

The status of payments associated with the order

  • pending: The payments are pending
  • paid: The payments has been paid
  • partially_refunded: The payments has been partially refunded
  • refunded: The payments has been partially refunded
Available options:
pending,
partially_paid,
paid,
partially_refunded,
refunded
​
customer
object
​
gross_amount
integer

Monetary amount in smallest unit for the currency before discounts

Example:

59800

​
net_amount
integer

Monetary amount in smallest unit for the currency after discounts

Example:

47840

​
total_discount
integer
read-only

Monetary amount in smallest unit for the currency

Required range: x >= 0
Example:

23130

​
total_manual_discount_amount
integer
read-only

Monetary amount in smallest unit for the currency

Required range: x >= 0
Example:

0

​
shipping_address
object
​
billing_address
object
​
metadata
object

Additional data related to the order

​
comment
string

Comment on the order

Maximum string length: 255
​
salesperson_id
string

Id of the sales person if other then the operator

​
salesperson_name
string

Name of the sales person

​
delivery_at
string<date-time>

Requested delivery time by the customer, default value is ASAP relative to when the order was created.

​
pickup_at
string<date-time>

Requested pickup time for the courier

​
courier_id
string

Id of the courier responsible for the delivery

​
pre_order
boolean

Customer requested the delivery to be later, i.e not ASAP, see delivery_at for when the delivery should be completed.

​
time_to_live
integer

Time-To-Live (TTL) for the order created in seconds. The value is interpreted as a delta from the time that an order was last modified (update_at).

All drafts related to an order will be deleted when the TTL expires and the order will be emptied for all data except

  • order_number
  • order_id
  • external_ids
  • created_at
  • updated_at
  • deleted_at
Required range: x >= 86400
Example:

94672800

​
itinerary
object[]
​
external_ids
object[]
​
items
object[]

Update status on order items

Minimum array length: 1
​
version
integer
read-only

The version of the order. Incremented when the order is updated.

​
type
string

Describe the type of an order.

Example:

"delivery"

​
order_number
string
Example:

"order123456"

​
order_id
string

The order id, defaults to the resource id, UUID.

Requires split_draft option to be disabled.

Required string length: 1 - 255
​
time_to_live_expires_at
string<data-time>

The date-time when the resource expires.

​
multiple_authorizations
boolean

Allow multiple authorizations per order item

​
payment_details
object
​
sessions
object[]
read-only

A list of sessions for this order

​
authorizations
object[]
read-only

A list of authorizations for this order

​
captures
object[]
read-only

A list of captures for this order

​
refunds
object[]
read-only

A list of refunds for this order

​
cancellations
object[]
read-only

A list of cancellations for this order

​
discounts
object[]
read-only
​
store
object
​
external_links
object[]
​
attachments
object[]
​
comments
object[]
read-only
​
delivery_id
string
​
_links
object[]
read-only

The links related to resource

​
state
string

The combined state of all events

  • failure if any of the events reports as error or failure
  • pending if there is no events or if the latest status for any service is pending
  • success if the latest status for all services is success