GetOrderByNumer

Retrieving an order based on its number.

  • Input data type => object
  • Output data type => object

Input parameters

  1. _session_hash (string)
  2. Required. Session identifier (received during login - doLogin)

  3. number (string)
  4. Required. Order number.

Output data

  1. created_at (dateTime)
  2. Entry creation date.

  3. updated_at (dateTime)
  4. Date of last modification of the entry.

  5. id (integer)
  6. Identifier

  7. number (integer)
  8. Number.

  9. is_confirmed (integer)
  10. Confirmed.

  11. sf_guard_user_id (integer)
  12. User identifier.

  13. order_status_id (integer)
  14. Order status identifier.

  15. description (integer)
  16. Customer comments.

  17. order_user_data_delivery_country (string)
  18. Country - delivery data

  19. order_user_data_delivery_full_name (string)
  20. Name and surname - delivery data

  21. order_user_data_delivery_address (string)
  22. Address - delivery data

  23. order_user_data_delivery_address_more (string)
  24. Continuation of the address - delivery data

  25. order_user_data_delivery_name (string)
  26. Name - delivery data

  27. order_user_data_delivery_surname (string)
  28. Surname - delivery data

  29. order_user_data_delivery_street (string)

    Support for this field has been withdrawn please use the fields order_user_data_delivery_address and order_user_data_delivery_address_more.

  30. order_user_data_delivery_house (string)

    Support for this field has been withdrawn please use the fields order_user_data_delivery_address and order_user_data_delivery_address_more.

  31. order_user_data_delivery_flat (string)

    Support for this field has been withdrawn please use the fields order_user_data_delivery_address and order_user_data_delivery_address_more.

  32. order_user_data_delivery_code (string)
  33. Postal code - delivery data

  34. order_user_data_delivery_town (string)
  35. City - delivery data

  36. order_user_data_delivery_phone (string)
  37. Phone number - delivery data

  38. order_user_data_delivery_company (string)
  39. Company name - delivery data

  40. order_user_data_delivery_vat_number (string)
  41. VAT number - delivery data

  42. order_user_data_billing_country (string)
  43. Country - billing data

  44. order_user_data_billing_full_name (string)
  45. Full name - billing data

  46. order_user_data_billing_address (string)
  47. Address - billing data

  48. order_user_data_billing_address_more (string)
  49. Continuation of the address - billing data

  50. order_user_data_billing_name (string)
  51. Name - billing data

  52. order_user_data_billing_surname (string)
  53. Surname - billing data

  54. order_user_data_billing_street (string)

    Support for this field has been withdrawn please use the fields order_user_data_billing_address and order_user_data_billing_address_more.

  55. order_user_data_billing_house (string)

    Support for this field has been withdrawn please use the fields order_user_data_billing_address and order_user_data_billing_address_more.

  56. order_user_data_billing_flat (string)

    Support for this field has been withdrawn please use the fields order_user_data_billing_address and order_user_data_billing_address_more.

  57. order_user_data_billing_code (string)
  58. Postal code - billing data

  59. order_user_data_billing_town (string)
  60. City - billing data

  61. order_user_data_billing_phone (string)
  62. Phone number - billing data

  63. order_user_data_billing_company (string)
  64. Company name - billing data

  65. order_user_data_billing_vat_number (string)
  66. VAT number - billing data

  67. order_delivery_name (string)
  68. Delivery name

  69. order_delivery_cost (double)
  70. Delivery cost

  71. order_delivery_tax (double)
  72. VAT rate

  73. order_delivery_number (string)
  74. Shipment number

  75. order_currency_name (string)
  76. Currency name

  77. order_currency_exchange (string)
  78. Currency exchange rate

  79. order_currency_shortcut (string)
  80. Currency shortcut

  81. merchant_notes (string)
  82. Merchant notes

  83. order_discount_value (double)
  84. Order discount value

  85. order_discount_type (string)
  86. Order discount type. (% - percentage / P - amount).

  87. total_amount (double)
  88. Total order amount (includes delivery costs)

  89. client_email (string)
  90. Email address of the customer who placed the order

  91. order_allegro_delivery_method_id (string)
  92. Allegro delivery method guid identifier

  93. order_allegro_checkout_form_id (string)
  94. Allegro Order Identifier GUID

  95. client_request_invoice (integer)
  96. Client has requested an invoice

  97. order_delivery_type (string)

    Delivery type - available values:

    1. ppo - Polish Post - Pickup Point
    2. ppk - Polish Post - Courier
    3. inpostp - Inpost - Parcel Machines
  98. order_delivery_pickup_point (string)

    Pickup point identifier

  99. has_allegro_smart_delivery (integer)

    Allegro Smart Delivery

  100. order_allegro_username (string)

    Allegro username of the person who placed the order