--- title: List Merchants slug: mihai-tests/list-merchants createdAt: 2025-05-02T10:16:35.483Z --- { "id": "IdXalkNYPWTWmOjmQqKmW", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.sandbox.tripleup.dev/partner/merchants", "servers": [ { "url": "https://api.sandbox.tripleup.dev/partner/merchants", "description": "triple Sandbox" } ], "name": "List Merchants", "description": "

Returns a list of Merchants, optionally filtered.

\n

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

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "optional", "name": "merchant_external_id", "type": "string", "description": "

Partner-provided external ID

" }, { "kind": "optional", "name": "page", "type": "integer", "description": "

The page of results for returned Objects.

", "default": 1 }, { "kind": "optional", "name": "page_size", "type": "integer", "description": "

The size of pages for returned Objects.

", "default": 100 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "Merchants", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "merchants", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/Merchant", "customType": "Merchant[]", "schema": [ { "name": "address", "kind": "required", "type": "object", "description": "A physical address in the world, with required fields.\n\ntriple uses address validation services to update and standardize\naddresses on our platform. Address data sent to the API may be updated\nas we process, validate, and normalize addresses.\n", "modelRef": "#/components/schemas/StrictAddress", "customType": "StrictAddress", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "Address", "description": "", "modelRef": "#/components/schemas/Address", "schema": [ { "name": "city", "kind": "optional", "type": "string", "description": "Municipality or city name", "example": "PITTSBURGH" }, { "name": "complete", "kind": "optional", "type": "string", "description": "The complete delivery address, composed from the Address properties.\n", "example": "7370 BAKER ST, STE 100\nPITTSBURGH, PA 15206", "modelRef": "#/components/schemas/CompleteAddress", "customType": "CompleteAddress", "schema": [] }, { "name": "country_code", "kind": "optional", "type": "string", "description": "2-letter ISO-3166 country code", "example": "US", "modelRef": "#/components/schemas/CountryCode", "customType": "CountryCode", "schema": [] }, { "name": "country_subdivision_code", "kind": "optional", "type": "string", "description": "ISO-3166-2; 2-6 letter code for a country subdivision", "example": "PA" }, { "name": "latitude", "kind": "optional", "type": "number", "description": "", "example": 40.440624, "modelRef": "#/components/schemas/Latitude", "customType": "Latitude", "schema": [] }, { "name": "longitude", "kind": "optional", "type": "number", "description": "", "example": -79.995888, "modelRef": "#/components/schemas/Longitude", "customType": "Longitude", "schema": [] }, { "name": "postal_code", "kind": "optional", "type": "string", "description": "ZIP Code™, ZIP+4, or postal code", "example": "15206", "modelRef": "#/components/schemas/PostalCode", "customType": "PostalCode", "schema": [] }, { "name": "street_address", "kind": "optional", "type": "string", "description": "Single or multi-line physical address\n", "example": "7370 BAKER ST, STE 100\n" } ] } ] }, { "name": "assumed_name", "kind": "required", "type": "string", "description": "The (doing-business-as) name of the Merchant.", "modelRef": "#/components/schemas/MerchantAssumedName", "customType": "MerchantAssumedName", "schema": [] }, { "name": "merchant_category", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/MerchantCategory", "customType": "MerchantCategory", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "The 4-digit Merchant Category Code", "example": "7998", "modelRef": "#/components/schemas/MerchantCategoryCode", "customType": "MerchantCategoryCode", "schema": [] }, { "name": "description", "kind": "required", "type": "string", "readOnly": true, "description": "The description of the Merchant Category Code", "example": "Aquariums, Dolphinariums, Seaquariums, and Zoos" } ] }, { "name": "created_at", "kind": "required", "type": "string", "description": "RFC 3339 date time used for creation and mod times", "example": "2021-12-01T01:59:59.000Z", "modelRef": "#/components/schemas/Timestamp", "customType": "Timestamp", "schema": [] }, { "name": "external_id", "kind": "optional", "type": "object", "description": "Partner-provided, external ID for a Merchant.\n\nExternal IDs should be **stable** and **never sensitive**.\n\nExternal IDs do not need to be globally unique, but we encourage\nthe use of UUIDs. They must be unique for the Merchant within\nthe scope of its parent Content Provider.\n\nTo protect against accidental inclusion of sensitive personal\ninformation, external IDs may not be 9-digit numbers or use the\nUS Tax ID format (###-##-####).\n", "modelRef": "#/components/schemas/MerchantExternalId", "customType": "MerchantExternalId", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "ExternalId", "description": "", "modelRef": "#/components/schemas/ExternalId", "schema": [] } ] }, { "name": "id", "kind": "required", "type": "string", "description": "The triple-defined ID for the entity.", "example": "triple-abc-123", "modelRef": "#/components/schemas/EntityId", "customType": "EntityId", "schema": [] }, { "name": "logo_url", "kind": "optional", "type": "string", "description": "A link to the merchant's logo", "modelRef": "#/components/schemas/MerchantLogoUrl", "customType": "MerchantLogoUrl", "schema": [] }, { "name": "updated_at", "kind": "required", "type": "string", "description": "RFC 3339 date time used for creation and mod times", "example": "2021-12-01T01:59:59.000Z", "modelRef": "#/components/schemas/Timestamp", "customType": "Timestamp", "schema": [] } ] }, { "name": "total", "kind": "required", "type": "number", "description": "The total number of merchants.", "example": "" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "TripleBadRequestError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request is malformed." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "403", "description": "TripleNotAuthenticatedError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "Client authentication failed." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "TripleInvalidPathError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The url path or path parameter is invalid." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "409", "description": "TripleIntegrityError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request was well-formed but violated entity integrity constraints." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "415", "description": "TripleUnsupportedMediaType", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request defined an unsupported media type." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "422", "description": "TripleUnprocessableEntity", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request was well-formed but could not be processed." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "500", "description": "TripleInternalServerError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "Triple was unable to process the request due to an internal error." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "501", "description": "TripleNotImplementedError", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request failed because it requires a feature that is not yet implemented." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "503", "description": "TripleServiceUnavailable", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status_code", "kind": "required", "type": "integer", "description": "The 3-digit HTTP Response Status code", "example": 0 }, { "name": "content", "kind": "required", "type": "object", "description": "The error response content.", "example": "", "schema": [ { "name": "details", "kind": "optional", "type": "array", "description": "An array of error detail", "modelRef": "#/components/schemas/ErrorResponseDetails", "customType": "ErrorResponseDetails", "schema": [] }, { "name": "error_message", "kind": "required", "type": "string", "description": "Short description of what went wrong.", "example": "", "default": "The request failed due to a triple service interruption." }, { "name": "exception", "kind": "required", "type": "string", "description": "The exception type.", "example": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100' \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.sandbox.tripleup.dev/partner/merchants?page=1&page_size=100\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Merchants\n{\n \"merchants\": [\n {\n \"address\": {},\n \"assumed_name\": \"\",\n \"merchant_category\": {\n \"code\": \"7998\",\n \"description\": \"Aquariums, Dolphinariums, Seaquariums, and Zoos\"\n },\n \"created_at\": \"2021-12-01T01:59:59.000Z\",\n \"external_id\": {},\n \"id\": \"triple-abc-123\",\n \"logo_url\": \"\",\n \"updated_at\": \"2021-12-01T01:59:59.000Z\"\n }\n ],\n \"total\": 0\n}" }, { "id": "response-1-400", "language": "400", "code": "// TripleBadRequestError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-2-403", "language": "403", "code": "// TripleNotAuthenticatedError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-3-404", "language": "404", "code": "// TripleInvalidPathError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-4-409", "language": "409", "code": "// TripleIntegrityError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-5-415", "language": "415", "code": "// TripleUnsupportedMediaType\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-6-422", "language": "422", "code": "// TripleUnprocessableEntity\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-7-500", "language": "500", "code": "// TripleInternalServerError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-8-501", "language": "501", "code": "// TripleNotImplementedError\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" }, { "id": "response-9-503", "language": "503", "code": "// TripleServiceUnavailable\n{\n \"status_code\": 0,\n \"content\": {\n \"details\": [\n \"\"\n ],\n \"error_message\": \"\",\n \"exception\": \"\"\n }\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "id": "kyoa1TKdv0p4zcEOjK--P", "type": "paragraph", "children": [ { "text": "Returns a list of Merchants, optionally filtered." } ] }, { "id": "NwwIdsve_XZjArijMJhfe", "type": "paragraph", "children": [ { "text": "This list can be used to find a Merchant's ID given an external ID.\nThis endpoint has a limit of up to 100 merchants per page." } ] } ] }