Triple API and Webhooks
Offer Providers
Create a Merchant Location
1min
POST
https://api.tripleup.dev/partner/merchant-locations
triple Prod
BODY PARAMETERS
body
object
address
object
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.
email
string
Example: merchant.location@merchant.com
An email address for the location.
external_id
string
*Partner-provided, external ID for a Merchant Location.
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 Location 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 (###-##-####).
is_online
boolean
*Indicates whether or not this is an online location.
location_name
string
The name of the Merchant Location. If not specified, the Merchant
name is used.
location_website
string
Example: https://merchant-website.com
A URL for the location or online offer. Required if 'is_online' is true
parent_merchant_external_id
string
*Partner-provided, external ID for a Merchant Location.
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 Location 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 (###-##-####).
phone_number
string
A phone number for the location.
processor_merchant_ids
object[]
*The Processor Merchant ID (MID) is an unique number used to identify
the business for credit and debit card payment processing.
Physical locations and online retailers may have multiple MIDs, even for the same
processor network, usually for different departments or checkouts.
RESPONSES
201
Merchant Location
object
A specific, singular physical or online store for a particular Merchant.
Merchant Locations should specify Processor Merchant IDs (MIDs) so that
Transactions at those locations can be more accurately matched to
Offers.
address
object
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.
created_at
string<date-time>
Example: 2021-12-01T01:59:59.000Z
RFC 3339 date time used for creation and mod times
email
string
Example: merchant.location@merchant.com
An email address for the location.
external_id
string
*Partner-provided, external ID for a Merchant Location.
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 Location 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 (###-##-####).
id
string
*Example: triple-abc-123
The triple-defined ID for the entity.
is_online
boolean
*Indicates whether or not this is an online location.
location_name
string
The name of the Merchant Location. If not specified, the Merchant
name is used.
location_website
string
Example: https://merchant-website.com
A URL for the location or online offer. Required if 'is_online' is true
parent_merchant_external_id
string
*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 (###-##-####).
phone_number
string
A phone number for the location.
processor_merchant_ids
object[]
The Processor Merchant ID (MID) is an unique number used to identify
the business for credit and debit card payment processing.
Physical locations and online retailers may have multiple MIDs, even for the same
processor network, usually for different departments or checkouts.
updated_at
string<date-time>
Example: 2021-12-01T01:59:59.000Z
RFC 3339 date time used for creation and mod times
400
TripleBadRequestError
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
403
TripleNotAuthenticatedError
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
404
TripleInvalidPathError
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
409
TripleIntegrityError
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
415
TripleUnsupportedMediaType
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
422
TripleUnprocessableEntity
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
500
TripleInternalServerError
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
501
TripleNotImplementedError
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
503
TripleServiceUnavailable
object
status_code
integer
*The 3-digit HTTP Response Status code
content
object
*The error response content.
Updated 24 Oct 2023
Did this page help you?