GEgetswipe
Vendor V2

Get vendor details

Changed on

Returns one vendor's details by your vendor_id.

get/v2/vendor/{vendor_id}

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/vendor/{vendor_id}
  • Auth
    HTTP bearer

Path parameters

vendor_idstring required

The vendor ID to be fetched

Response

Success

successboolean

Success flag

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

{
  "success": true,
  "data": [
    {
      "vendor_id": "123",
      "name": "TATA RATAN",
      "email": "reddi@reddi.reddi",
      "discount": 10,
      "gstin": "27AARCS7202C1ZD",
      "company_name": "GSTN",
      "opening_balance": "1245",
      "credit_limit": 200,
      "billing_address": {
        "addr_id": -1,
        "addr_id_v2": "addr1",
        "pincode": "500075",
        "state": "State Name",
        "country": "India"
      },
      "opening_balance_type": 1,
      "dial_code": "91",
      "pan": "ABCD1234F",
      "notes": "Testing api",
      "cc_emails": "reddi@reddi.reddi,acb.a@bcd.con",
      "status": "Active",
      "custom_fields": [
        {
          "label": "Custom Field 1",
          "value": "Value 1"
        }
      ],
      "visibility": 1
    }
  ]
}

Changes

  • 0bcdbc62187bRevision changes
    • breaking

      the response's property type changed from object to array for status

    • warning

      removed the optional property / from the response with the status

    • info

      api operation id v2_get_vendor removed and replaced with get_vendor