List Merchants

1 min

GET

https://api.sandbox.tripleup.dev/partner/merchants

Returns a list of Merchants, optionally filtered.

This list can be used to find a Merchant's ID given an external ID. This endpoint has a limit of up to 100 merchants per page.

Query Parameters

merchant_external_idstring
Description
Partner-provided external ID
pageinteger
Description
The page of results for returned Objects.
Default
1
page_sizeinteger
Description
The size of pages for returned Objects.
Default
100

Responses

200Merchants

object
- merchantsMerchant[]required
  - addressStrictAddressrequired
    Description
    A physical address in the world, with required fields. triple uses address validation services to update and standardize addresses on our platform. Address data sent to the API may be updated as we process, validate, and normalize addresses.
    - Address
      - citystring
        Example
        PITTSBURGH
        Description
        Municipality or city name
      - completeCompleteAddress
        Example
        7370 BAKER ST, STE 100 PITTSBURGH, PA 15206
        Description
        The complete delivery address, composed from the Address properties.
      - country_codeCountryCode
        Example
        US
        Description
        2-letter ISO-3166 country code
      - country_subdivision_codestring
        Example
        PA
        Description
        ISO-3166-2; 2-6 letter code for a country subdivision
      - latitudeLatitude
        Example
        40.440624
      - longitudeLongitude
        Example
        -79.995888
      - postal_codePostalCode
        Example
        15206
        Description
        ZIP Code™, ZIP+4, or postal code
      - street_addressstring
        Example
        7370 BAKER ST, STE 100
        Description
        Single or multi-line physical address
  - assumed_nameMerchantAssumedNamerequired
    Description
    The (doing-business-as) name of the Merchant.
  - merchant_categoryMerchantCategoryrequired
    - codeMerchantCategoryCoderequired
      Example
      7998
      Description
      The 4-digit Merchant Category Code
    - descriptionstringrequired
      Example
      Aquariums, Dolphinariums, Seaquariums, and Zoos
      Description
      The description of the Merchant Category Code
  - created_atTimestamprequired
    Example
    2021-12-01T01:59:59.000Z
    Description
    RFC 3339 date time used for creation and mod times
  - external_idMerchantExternalId
    Description
    Partner-provided, external ID for a Merchant. External IDs should be **stable** and **never sensitive**. External IDs do not need to be globally unique, but we encourage the use of UUIDs. They must be unique for the Merchant within the scope of its parent Content Provider. To protect against accidental inclusion of sensitive personal information, external IDs may not be 9-digit numbers or use the US Tax ID format (###-##-####).
    - ExternalId
  - idEntityIdrequired
    Example
    triple-abc-123
    Description
    The triple-defined ID for the entity.
  - logo_urlMerchantLogoUrl
    Description
    A link to the merchant's logo
  - updated_atTimestamprequired
    Example
    2021-12-01T01:59:59.000Z
    Description
    RFC 3339 date time used for creation and mod times
- totalnumberrequired
  Description
  The total number of merchants.

400TripleBadRequestError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request is malformed.
  - exceptionstring<TripleBadRequestError>required
    Description
    The exception type.

403TripleNotAuthenticatedError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    Client authentication failed.
  - exceptionstring<TripleNotAuthenticatedError>required
    Description
    The exception type.

404TripleInvalidPathError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The url path or path parameter is invalid.
  - exceptionstring<TripleInvalidPathError>required
    Description
    The exception type.

409TripleIntegrityError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request was well-formed but violated entity integrity constraints.
  - exceptionstring<TripleIntegrityError>required
    Description
    The exception type.

415TripleUnsupportedMediaType

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request defined an unsupported media type.
  - exceptionstring<TripleUnsupportedMediaType>required
    Description
    The exception type.

422TripleUnprocessableEntity

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request was well-formed but could not be processed.
  - exceptionstring<TripleUnprocessableEntity>required
    Description
    The exception type.

500TripleInternalServerError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    Triple was unable to process the request due to an internal error.
  - exceptionstring<TripleInternalServerError>required
    Description
    The exception type.

501TripleNotImplementedError

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request failed because it requires a feature that is not yet implemented.
  - exceptionstring<TripleNotImplementedError>required
    Description
    The exception type.

503TripleServiceUnavailable

object
- status_codeintegerrequired
  Description
  The 3-digit HTTP Response Status code
- contentobjectrequired
  Description
  The error response content.
  - detailsErrorResponseDetails
    Description
    An array of error detail
  - error_messagestringrequired
    Description
    Short description of what went wrong.
    Default
    The request failed due to a triple service interruption.
  - exceptionstring<TripleServiceUnavailable>required
    Description
    The exception type.

curl

curl --request GET \
     --url 'https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Merchants
{
  "merchants": [
    {
      "address": {},
      "assumed_name": "",
      "merchant_category": {
        "code": "7998",
        "description": "Aquariums, Dolphinariums, Seaquariums, and Zoos"
      },
      "created_at": "2021-12-01T01:59:59.000Z",
      "external_id": {},
      "id": "triple-abc-123",
      "logo_url": "",
      "updated_at": "2021-12-01T01:59:59.000Z"
    }
  ],
  "total": 0
}

400

// TripleBadRequestError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

403

// TripleNotAuthenticatedError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

404

// TripleInvalidPathError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

409

// TripleIntegrityError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

415

// TripleUnsupportedMediaType
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

422

// TripleUnprocessableEntity
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

500

// TripleInternalServerError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

501

// TripleNotImplementedError
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

503

// TripleServiceUnavailable
{
  "status_code": 0,
  "content": {
    "details": [
      ""
    ],
    "error_message": "",
    "exception": ""
  }
}

Returns a list of Merchants, optionally filtered.

This list can be used to find a Merchant's ID given an external ID. This endpoint has a limit of up to 100 merchants per page.