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)

  2. number (string)

    3. Required. Order number.

Output data

  1. created_at (dateTime)

    2. Entry creation date.

  2. updated_at (dateTime)

    3. Date of last modification of the entry.

  3. id (integer)

    4. Identifier

  4. number (integer)

    5. Number.

  5. is_confirmed (integer)

    6. Confirmed.

  6. sf_guard_user_id (integer)

    7. User identifier.

  7. order_status_id (integer)

    8. Order status identifier.

  8. description (integer)

    9. Customer comments.

  9. order_user_data_delivery_country (string)

    10. Country - delivery data

  10. order_user_data_delivery_full_name (string)

    11. Name and surname - delivery data

  11. order_user_data_delivery_address (string)

    12. Address - delivery data

  12. order_user_data_delivery_address_more (string)

    13. Continuation of the address - delivery data

  13. order_user_data_delivery_name (string)

    14. Name - delivery data

  14. order_user_data_delivery_surname (string)

    15. Surname - delivery data

  15. 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.

  16. 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.

  17. 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.

  18. order_user_data_delivery_code (string)

    19. Postal code - delivery data

  19. order_user_data_delivery_town (string)

    20. City - delivery data

  20. order_user_data_delivery_phone (string)

    21. Phone number - delivery data

  21. order_user_data_delivery_company (string)

    22. Company name - delivery data

  22. order_user_data_delivery_vat_number (string)

    23. VAT number - delivery data

  23. order_user_data_billing_country (string)

    24. Country - billing data

  24. order_user_data_billing_full_name (string)

    25. Full name - billing data

  25. order_user_data_billing_address (string)

    26. Address - billing data

  26. order_user_data_billing_address_more (string)

    27. Continuation of the address - billing data

  27. order_user_data_billing_name (string)

    28. Name - billing data

  28. order_user_data_billing_surname (string)

    29. Surname - billing data

  29. 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.

  30. 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.

  31. 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.

  32. order_user_data_billing_code (string)

    33. Postal code - billing data

  33. order_user_data_billing_town (string)

    34. City - billing data

  34. order_user_data_billing_phone (string)

    35. Phone number - billing data

  35. order_user_data_billing_company (string)

    36. Company name - billing data

  36. order_user_data_billing_vat_number (string)

    37. VAT number - billing data

  37. order_delivery_name (string)

    38. Delivery name

  38. order_delivery_cost (double)

    39. Delivery cost

  39. order_delivery_tax (double)

    40. VAT rate

  40. order_delivery_number (string)

    41. Shipment number

  41. order_currency_name (string)

    42. Currency name

  42. order_currency_exchange (string)

    43. Currency exchange rate

  43. order_currency_shortcut (string)

    44. Currency shortcut

  44. merchant_notes (string)

    45. Merchant notes

  45. order_discount_value (double)

    46. Order discount value

  46. order_discount_type (string)

    47. Order discount type. (% - percentage / P - amount).

  47. total_amount (double)

    48. Total order amount (includes delivery costs)

  48. client_email (string)

    49. Email address of the customer who placed the order

  49. order_allegro_delivery_method_id (string)

    50. Allegro delivery method guid identifier

  50. order_allegro_checkout_form_id (string)

    51. Allegro Order Identifier GUID

  51. client_request_invoice (integer)

    52. Client has requested an invoice

  52. order_delivery_type (string)

    Delivery type - available values:

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

    Pickup point identifier

  54. has_allegro_smart_delivery (integer)

    Allegro Smart Delivery

  55. order_allegro_username (string)

    Allegro username of the person who placed the order