Get vendor details

Returns one vendor’s details by your vendor_id.

GET /v2/vendor/{vendor_id}

Get vendor details

cURL

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/vendor/{vendor_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": [
    {
      "vendor_id": "123",
      "name": "TATA RATAN",
      "phone": 1234567890,
      "email": "[e-mail]",
      "discount": 10,
      "gstin": "27AARCS7202C1ZD",
      "company_name": "GSTN",
      "opening_balance": "1245",
      "credit_limit": 200,
      "billing_address": {
        "addr_id": -1,
        "addr_id_v2": "addr1",
        "address_line1": "",
        "address_line2": "",
        "pincode": "500075",
        "city": "",
        "state": "State Name",
        "country": "India"
      },
      "opening_balance_type": 1,
      "dial_code": "91",
      "profile_image": "",
      "pan": "ABCD1234F",
      "notes": "Testing api",
      "cc_emails": "[e-mail],[e-mail]",
      "status": "Active",
      "tags": [
        "<string>"
      ],
      "custom_fields": [
        {
          "label": "Custom Field 1",
          "value": "Value 1"
        }
      ],
      "visibility": 1
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Path Parameters

vendor_id · string · required

The vendor ID to be fetched

Response

200

application/json

Success

success · boolean

Success flag

Example:

true

message · string

Response message

Example:

""

error_code · string

Error Code

Example:

""

errors · object

Errors

data · object[]

Show child attributes