Create a merchant

POST

/merchants

const url = 'https://sandbox.partners.loops.sa/v1/merchants';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '6f1c2a9e-3b7d-4c55-9a40-2d8e1f7b9c31',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"external_ref":"BR-01","name":{"en":"example","ar":"example"},"owner":{"name":"Sara Al-Harbi","email":"sara@example.sa","phone":"+966501234567"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://sandbox.partners.loops.sa/v1/merchants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 6f1c2a9e-3b7d-4c55-9a40-2d8e1f7b9c31' \
  --data '{ "external_ref": "BR-01", "name": { "en": "example", "ar": "example" }, "owner": { "name": "Sara Al-Harbi", "email": "sara@example.sa", "phone": "+966501234567" } }'

Creates a new business in Loops and connects it to your application. Loops invites the owner by email to sign in to Loops; you never handle the owner’s password.

The merchant can be used straight away: add brands, locations and menus. Its locations go live on delivery apps after Loops approves the business profile.

Don’t send Loops-Merchant-Id on this request.

Authorizations

bearerAuth
merchant:write

Parameters

Header Parameters

Idempotency-Key

string

A unique value (a UUID) for this request. If you retry with the same key within 24 hours, you get the original response instead of a second change.

Request Body^required

application/json

object

external_ref

required

Your own ID for this object, from your system. Unique within its type for the merchant (for menu items, within the brand). Letters, digits, -, _, . and :.

string

>= 1 characters <= 64 characters /^[A-Za-z0-9._:-]+$/

name

required

Text in English and Arabic. Delivery apps in Saudi Arabia show both, so both are required.

object

required

string

>= 1 characters <= 120 characters

required

string

>= 1 characters <= 120 characters

owner

required

object

name

required

string

email

required

Loops sends the sign-in invitation here.

string format: email

phone

required

E.164 format.

string

Responses

201

The new merchant.

application/json

object

required

string

external_ref

string | null

name

required

Text in English and Arabic.

object

string | null

status

required

string

Allowed values: active suspended

owner

object

name

string

email

string

phone

string

invitation

Whether the owner has accepted the invitation to sign in to Loops.

string

Allowed values: sent accepted

business_profile_status

required

draft: being filled in. in_review: submitted, Loops is reviewing it. approved: locations can go live on delivery apps. rejected: fix what the review says and submit again.

string

Allowed values: draft in_review approved rejected

created_at

required

string format: date-time

Example

{
  "id": "mer_7Hq2Lw8Z",
  "external_ref": "CUST-10021",
  "status": "active",
  "owner": {
    "invitation": "sent"
  },
  "business_profile_status": "draft"
}

400

The request is invalid. errors lists each problem.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

Allowed values: invalid_request invalid_file merchant_required unauthorized insufficient_scope scope_not_granted connection_not_active application_suspended not_found merchant_not_found merchant_exists external_ref_conflict business_profile_locked idempotency_key_reused rate_limited upstream_unavailable

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

401

The access token is missing, expired or invalid.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

403

Not allowed: the scope isn’t approved or granted, the connection is not active, or your application is suspended. See code.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

409

The request conflicts with the current state, for example an external_ref already in use, or a business profile that is in review. See code.

application/problem+json

RFC 9457 Problem Details with a stable code.

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine-readable error code. Switch on this, not on title.

string

detail

string

request_id

required

string

existing_id

For external_ref_conflict, the ID of the object that already uses the reference.

string

errors

Field errors, for invalid_request.

Array<object>

object

field

string

message

string

Example

{
  "type": "https://docs.partners.loops.sa/errors/external_ref_conflict",
  "title": "External reference already used",
  "status": 409,
  "code": "invalid_request",
  "detail": "A location with external_ref BR-01 already exists.",
  "request_id": "req_01J9X7P2QK",
  "existing_id": "loc_2Xf9K",
  "errors": [
    {
      "field": "products[3].price",
      "message": "Required unless the product has variants."
    }
  ]
}

Create a merchant

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

400

Example

401

Example

403

Example

409

Example

Request Body^required