Knowledge Base / API
עברית

Ask AI

✦ AI answer

Thinking…

Sources

    CompanyOperations – Get All Supplier Number Information for a Company

    When should this function be used?

    This function is intended for dealers or suppliers who want to retrieve the supplier numbers of a business registered under them.

    Below is a link to the function in JSON.

    Request method: POST.
    Get all supplier number information for a company

    https://secure.cardcom.solutions/api/v11/CompanyOperations/MeagedGetCompanyInfo

    Below are the parameters that must be passed to the function.

    Legend:

    Red parameter – required

    Bold parameter – recommended

    A parameter that is neither red nor bold is optional.

    No.
    Parameter Example values Description
    1 SupplierUserName (String) The supplier's username.
    2 Secret (String) Secret.
    3 BusinessRegistrationNumber (String) Business registration number / ID number / company registration number.
    4 SapakNumber (Int) Supplier number.

     

    Response for Get All Supplier Number Information for a Company.

    No.
    Parameter Example values Description
    1 ResponseCode  (Int) Response code.
    2 Description (String) Description.
    3 MeagedSapakInfo – array of objects.

    SapakNumber – (Int)

    ---

     

    SapakStatus –

    • UnderTest – Under review

    • InProcess – In process

    • Approved – Approved

    • Blocked – Blocked

    • Error – Error

    MeagedSapakInfo – information about an aggregator's supplier number.

    ---

    SapakNumber – supplier number.

    ---

    SapakStatus – supplier status.

     

    Below is sample code for the function, along with the response.

    Example request:

    {
      "SupplierUserName": "<string>",
      "Secret": "<string>",
      "BusinessRegistrationNumber": "<long>",
      "SapakNumber": "<integer>"
    }

    Example response:

    {
      "ResponseCode": 0,
      "Description": "string",
      "MeagedSapakInfo": [
        {
          "SapakNumber": 0,
          "SapakStatus": "UnderTest"
        }
      ]
    }

    Was this article helpful?