Get Action Logs

Function

Get recent action logs (at most 100 logs) related to an order in descending order.

URL

GET <<api_domain>>/v1/orders/:id/action_logs

Request Example

curl --request GET \
     --url '<<api_domain>>/v1/orders/id/action_logs' \
     --header 'Accept: application/json'

Request Parameters


`id` Required	`string`	Order Id of the order

Response Example

{
  "items": [
    {
      "key": "updated_status",
      "data": {  // see the type of key and data mapping below
         "updated_status": "string"
         "reason": "string"
      },
      "created_at": "2021-11-02T04:06:13.304Z",
      "performer_name": "shop",
      "performer_type": "User",
      "performer_id": "60c1e027a47d91004377f129",
      "performing_application_id": "60c1e027a47d91004377f12f"
    }
  ]
}


`items`	`Array of Action logs`
`items[].key`	`String`	product id
`items[].data`	`String`
`items[].created_at`	`Datetime`
`items[].performer_name`	`String`	name of the performer
`items[].performer_type`	`String`	e.g. `User`
`items[].performer_id`	`String`	the id of the person who perform it
`items[].performing_application_id`	`String`	the application id of the application perform it

{
  key: 'execute_shipment_job_failed'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'updated_delivery_status'
  data: {
    updated_delivery_status: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'updated_ref_delivery_status'
  data: {
    updated_ref_delivery_status: string 
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'updated_status'
  data: {
    updated_status: string
    reason: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'updated_payment_status'
  data: {
    updated_payment_status: string
    reason: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'set_shipment_id'
  data: { 
    set_shipment_id: string 
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'updated_delivery_details '
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'updated_customer_details '
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'updated_order_details'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'added_a_comment'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'create_delivery_remark'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'update_delivery_remark'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'delete_delivery_remark'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'delivery_location_updated'
  data: {
    current_location_name: string
    updated_location_name: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'returning_store_updated'
  data: {
    updated_location_name: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'order_edit'
  data: {
    total: [ {money_object}, {money_object} ]
    subtotal: [ {money_object}, {money_object} ]
    discount: [ {money_object}, {money_object} ]
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'order_split'
  data: { 
    order_id: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'order_split_changes'
  data: { 
    total: [{money_object}, {money_object}]
    subtotal: [{money_object}, {money_object}]
    discount: [{money_object}, {money_object}]
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'order_split_from'
  data: { 
    order_id: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'update_delivery_method'
  data: {
    from_delivery_method: {lang_object}
    to_delivery_method: {lang_object}
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'update_payment_method'
  data: {
    from_payment_method: {lang_object}
    to_payment_method: {lang_object}
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'product_subscription_created'
  data: {
    product_subscription_id: string
    product_title: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'cancell_product_subscription'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'unmatch_amount'
  data: { 
    amount: string 
  } 
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'added_order_payment_slip'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'order_transferred'
  data: {
    original_customer_id: string
    original_customer_name: string
    new_customer_id: string
    new_customer_name: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'order_created'
  data: {
    created_by: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'customer_cancel_requested'
  data: {
    cancelled_reason: string
    performer_ip: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'customer_cancel_failed'
  data: {
    cancelled_reason: string
    performer_ip: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'chargeback_request'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'chargeback_review'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'chargeback_lost'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'chargeback_expired'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'chargeback_won'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'chargeback_canceled'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'chargeback_resolved'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'execute_shipment_failed'
  data: { 
    messasge: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'cancel_shipment_failed'
  data: { 
    messasge: string
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'update_invoice_request'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'create_invoice'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'cancel_invoice'
  data: null
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}

{
  key: 'update_invoice_status'
  data: {
    status: [string, string]
    updated_at: [string, string]
  }
  created_at: string
  performer_name: string
  performer_id: string
  performer_application_id: string
  performer_type: string
}