Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
order.comments

aid_orders_id_comments_post

Create a new order comment

scopes:

  • admin:shopping
  • write:shopping
post/accounts/{aid}/shopping/orders/{order_id}/comments

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

order_idstring required

The resource identifier string

Query parameters

include_eventsstring[]

include order events in response

Request body

idstring

An id that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
bodystring required
visibility'private' | 'public'

The comment is private, hidden from the customer

Example request

{
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e"
}

Response

order

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
cancelled_reasonstring

The reason why the order was canceled.

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

The resource ID. Defaults to UUID v4

cancelled_atstring date-time

Read-only timestamp, automatically assigned on back-end.

closed_bystring

The resource ID. Defaults to UUID v4

closed_atstring date-time

Read-only timestamp, automatically assigned on back-end.

status'open' | 'closed' | 'cancelled'

Order status

payment_status'pending' | 'partially_paid' | 'paid' | 'partially_refunded' | 'refunded'

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
gross_amountinteger

Monetary amount in smallest unit for the currency before discounts

net_amountinteger

Monetary amount in smallest unit for the currency after discounts

total_discountinteger

Monetary amount in smallest unit for the currency

total_manual_discount_amountinteger

Monetary amount in smallest unit for the currency

metadataobject

Additional data related to the order

commentstring

Comment on the order

salesperson_idstring

Id of the sales person if other then the operator

salesperson_namestring

Name of the sales person

delivery_atstring date-time

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

pickup_atstring date-time

Requested pickup time for the courier

courier_idstring

Id of the courier responsible for the delivery

pre_orderboolean

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

time_to_liveinteger

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
versioninteger

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

typestring

Describe the type of an order.

order_numberstring
currencystring iso-4217 required

The tree-character ISO-4217 currency

order_idstring

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

Requires split_draft option to be disabled.

time_to_live_expires_atstring data-time

The date-time when the resource expires.

multiple_authorizationsboolean

Allow multiple authorizations per order item

delivery_idstring
statestring

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

Example response

{
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "cancelled_reason": "customer",
  "cancelled_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "closed_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
  "customer": {
    "metadata": {
      "dob_year": 1985
    },
    "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "first_name": "John",
    "last_name": "Doe",
    "email": "customer@example.com",
    "phone_number": "+4799999999",
    "enrolled_by": {
      "type": "url",
      "value": "https://facebook.com"
    },
    "marketing_consent": {
      "sms": {
        "consent": true,
        "updated_at": "2018-01-12T13:42:00Z"
      },
      "email": {
        "consent": true,
        "updated_at": "2018-01-12T13:42:00Z"
      }
    },
    "addresses": [
      {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "country": "NO",
        "latitude": 59.942112,
        "longitude": 10.716991,
        "comment": "5th floor, use doorbell."
      }
    ],
    "company": {
      "organization_number": "123456789MVA",
      "bussiness_name": "TKP tech AS",
      "department": "sales department",
      "industry": "computer industry"
    },
    "gender": "male",
    "date_of_birth": "1990-09-20"
  },
  "gross_amount": 39800,
  "net_amount": 27840,
  "total_discount": 23130,
  "shipping_address": {
    "address_line": "Sommerkroveien 34",
    "address_line_2": "PB 123",
    "postal_code": "0349",
    "postal_place": "Oslo",
    "country": "NO",
    "first_name": "John",
    "last_name": "Doe",
    "comment": "5th floor, use doorbell."
  },
  "billing_address": {
    "address_line": "Sommerkroveien 34",
    "address_line_2": "PB 123",
    "postal_code": "0349",
    "postal_place": "Oslo",
    "country": "NO",
    "first_name": "John",
    "last_name": "Doe",
    "comment": "5th floor, use doorbell."
  },
  "time_to_live": 94672800,
  "itinerary": [
    {
      "arrival_address": {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "latitude": 59.942112,
        "longitude": 10.716991,
        "country": "NO"
      },
      "departure_address": {
        "address_line": "Sommerkroveien 34",
        "address_line_2": "PB 123",
        "postal_code": "0349",
        "postal_place": "Oslo",
        "latitude": 59.942112,
        "longitude": 10.716991,
        "country": "NO"
      }
    }
  ],
  "items": [
    {
      "id": "175938",
      "groups": [
        {
          "id": "B234",
          "name": "Stol"
        },
        {
          "id": "B1",
          "name": "Møbel"
        }
      ],
      "line_id": 1,
      "quantity": 2,
      "gross_amount": 39800,
      "net_amount": 27840,
      "tax_lines": [
        {
          "amount": 5584,
          "amount_dwh": "5584.0440",
          "included_in_price": true,
          "percentage": 25,
          "tax_basis": 27920,
          "tax_basis_dwh": "27920.22",
          "tax_code": "3",
          "tax_group": "Vmva-høy"
        }
      ],
      "description": "Stablestol for utendørsbruk",
      "description_alias": "Staplestol",
      "eligible_for_discount": true,
      "discount_lines": [
        {
          "amount": 4400,
          "percentage": 44,
          "discount_id": "766da0ef-9283-42bd-b012-0582344ec53c",
          "line_id": 1
        }
      ],
      "additions": [
        {
          "id": "C1203",
          "description": "Extra Cheese",
          "gross_amount": 27840,
          "groups": [
            {
              "id": "B234",
              "name": "Stol"
            },
            {
              "id": "B1",
              "name": "Møbel"
            }
          ]
        }
      ],
      "store": {
        "id": "SL02",
        "organization_number": "123456789MVA",
        "name": "SC Oslo",
        "business_name": "SC Oslo AS"
      },
      "external_id": "SL02-94821948",
      "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_source": "ecb"
    }
  ],
  "type": "delivery",
  "order_number": "order123456",
  "currency": "NOK",
  "payment_details": {
    "remaining_capture_amount": 27840,
    "remaining_refund_amount": 27840,
    "remaining_cancellation_amount": 27840,
    "amount_due": 27840,
    "remaining_authorization_amount": 27840
  },
  "sessions": [
    {
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "items": [
        {
          "amount": 27840
        }
      ]
    }
  ],
  "authorizations": [
    {
      "items": [
        {
          "original_currency": "SEK",
          "original_gross_amount": 39800,
          "conversion_rate_ppm": 1099000,
          "conversion_rate_source": "ecb",
          "amount": 27840
        }
      ],
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa"
        }
      },
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "captures": [
    {
      "items": [
        {
          "original_currency": "SEK",
          "original_gross_amount": 39800,
          "conversion_rate_ppm": 1099000,
          "conversion_rate_source": "ecb",
          "amount": 27840
        }
      ],
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa"
        }
      },
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "refunds": [
    {
      "items": [
        {
          "original_currency": "SEK",
          "original_gross_amount": 39800,
          "conversion_rate_ppm": 1099000,
          "conversion_rate_source": "ecb",
          "amount": 27840
        }
      ],
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa"
        }
      },
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "cancellations": [
    {
      "items": [
        {
          "original_currency": "SEK",
          "original_gross_amount": 39800,
          "conversion_rate_ppm": 1099000,
          "conversion_rate_source": "ecb",
          "amount": 27840
        }
      ],
      "processed_by": "dintero-checkout",
      "payment_details": {
        "psp": "Bambora",
        "payment_product": "bambora",
        "payment_product_type": "bambora.creditcard",
        "card": {
          "masked_pan": "4444 **** **** 4448",
          "type": "Credit",
          "brand": "Visa"
        }
      },
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "amount": 27840,
      "authorization_id": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ],
  "store": {
    "id": "SL02",
    "organization_number": "123456789MVA",
    "name": "SC Oslo",
    "business_name": "SC Oslo AS"
  },
  "external_links": [
    {
      "text": "Order Receipt",
      "href": "https://example.dintero.com/receipts/234CC019-8BA9-4DDB-9A40-8C9EE0BB943C?type=pdf"
    }
  ],
  "attachments": [
    {
      "bus_reservation": {
        "booking_id": "NE 138 47794",
        "itinerary": [
          {
            "departure_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "arrival_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "operator": "SAS"
          }
        ]
      },
      "car_reservation": {
        "booking_id": "TV 347794",
        "itinerary": [
          {
            "rental_company": "Avis",
            "pick_up_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "drop_off_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            }
          }
        ]
      },
      "ferry_reservation": {
        "booking_id": "NE 138 47794",
        "itinerary": [
          {
            "departure_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "arrival_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "operator": "SAS"
          }
        ]
      },
      "metro_reservation": {
        "booking_id": "NE 138 47794",
        "itinerary": [
          {
            "departure_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "arrival_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "operator": "SAS"
          }
        ]
      },
      "taxi_reservation": {
        "booking_id": "NE 138 47794",
        "itinerary": [
          {
            "departure_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "arrival_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "operator": "SAS"
          }
        ]
      },
      "train_reservation": {
        "booking_id": "NE 138 47794",
        "itinerary": [
          {
            "departure_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "arrival_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "operator": "SAS"
          }
        ]
      },
      "tram_reservation": {
        "booking_id": "NE 138 47794",
        "itinerary": [
          {
            "departure_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "arrival_address": {
              "address_line": "Sommerkroveien 34",
              "address_line_2": "PB 123",
              "postal_code": "0349",
              "postal_place": "Oslo",
              "country": "NO"
            },
            "operator": "SAS"
          }
        ]
      }
    }
  ],
  "comments": [
    {
      "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e"
    }
  ],
  "events": [
    {
      "id": "bd04c959-d159-49b4-a096-2d84e014a8da",
      "created_by": "bd04c959-d159-49b4-a096-2d84e014a8da"
    }
  ]
}