Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference
  2. Orders

Comments

PreviousOrdersNextStatuses
  • GETsales Order Management V1Get Comments List Get
  • POSTsales Order Management V1Add Comment Post

sales Order Management V1Get Comments List Get

get

Lists comments for a specified order.

Path parameters
idstringRequired

(Required) The order ID.

Example: <integer>
Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/orders/{id}/comments HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "comment": "sit velit amet",
      "is_customer_notified": -77656477,
      "is_visible_on_front": 1012491,
      "parent_id": 50748784,
      "created_at": "eiusmod cillum enim velit",
      "entity_id": 67790299,
      "entity_name": "consequat aliqua",
      "status": "dolor",
      "extension_attributes": {}
    },
    {
      "comment": "qui in sint",
      "is_customer_notified": 4792751,
      "is_visible_on_front": 15062830,
      "parent_id": -39993758,
      "created_at": "aliqua adipisicing do",
      "entity_id": -72231422,
      "entity_name": "veniam eiusmod do",
      "status": "mollit occaecat anim consequat",
      "extension_attributes": {}
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "sint irure",
            "value": "pariatur ipsum consectetur",
            "condition_type": "esse Lorem reprehenderit ea"
          },
          {
            "field": "qui",
            "value": "Excepteur amet veli",
            "condition_type": "dolore"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "nulla culpa",
            "value": "est id",
            "condition_type": "id magna ut"
          },
          {
            "field": "elit eu",
            "value": "nulla in officia",
            "condition_type": "officia incididunt"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "pariatur magna id ea eu",
        "direction": "dolore ullamco elit"
      },
      {
        "field": "culpa in labore nisi ipsum",
        "direction": "minim id"
      }
    ],
    "page_size": -43864153,
    "current_page": 27757310
  },
  "total_count": 95113004
}

sales Order Management V1Add Comment Post

post

Adds a comment to a specified order.

Path parameters
idstringRequired

(Required) The order ID.

Example: <integer>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"statusHistory":{"comment":"magna","is_customer_notified":-85897747,"is_visible_on_front":93007737,"parent_id":-18219341,"created_at":"sunt sint","entity_id":-55065063,"entity_name":"ullamco proident ea","status":"nulla eiusmod","extension_attributes":{}}}
Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/orders/{id}/comments HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 257

{
  "statusHistory": {
    "comment": "magna",
    "is_customer_notified": -85897747,
    "is_visible_on_front": 93007737,
    "parent_id": -18219341,
    "created_at": "sunt sint",
    "entity_id": -55065063,
    "entity_name": "ullamco proident ea",
    "status": "nulla eiusmod",
    "extension_attributes": {}
  }
}
true