in Platform

SMS Alert

SMS Alert

HTTP Status Codes

SMSAlert uses standard HTTP status codes to communicate errors:

Status Code

Value

200

OK – Everything went as planned.

202

Accepted – Request accepted.

400

Bad Request – Something in your header or request body was malformed.

401

Unauthorised – Necessary credentials were either missing or invalid.

402

Payment Required – The action is not available on your plan, or you have exceeded usage limits for your current plan.

403

Your credentials are valid, but you don’t have access to the requested resource.

404

Not Found – The object you’re requesting doesn’t exist.

409

Conflict – You might be trying to update the same resource concurrently.

429

Too Many Requests – You are calling our APIs more frequently than we allow.

5xx

Server Errors – Something went wrong on our end. Please try again.

OTP

POST Generate OTP

https://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&action=generateloginotp&mobileno=8010551055

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

generateloginotp

Action

mobileno

8010551055

Shopify customer register number

Example Request

Example Response

200 – OK
{
    "status": "error",
    "description": "Sorry, but you do not have a registered phone number"
}

Example Response

200 – OK
{
    "status": "error",
    "description": "Sorry, your account is not active, please contact to site admin."
}

Example Response

200 – OK
{
    "status": "success",
    "description": {
        "desc": "1 messages scheduled for delievery",
        "batchid": "34163609",
        "batch_dtl": [
            {
                "mobileno": "8010551055",
                "msgid": "10823108",
                "status": "AWAITED-DLR"
            }
        ]
    }
}

OTP

POST Generate Register OTP

https://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&action=generateregotp&mobileno=8010551055&emailid=smsalert123%40gmail.com

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

generateregotp

Action

mobileno

8010551055

mobile number

emailid

smsalert123@gmail.com

Email id

Example Request

Example Response

200 – OK
{
    "status": "error",
    "description": "This mobile number is already registered, please login."
}

Example Response

200 – OK
{
    "status": "error",
    "description": "This email is already registered, please login."
}

Example Response

200 – OK
{
    "status": "success",
    "description": {
        "desc": "1 messages scheduled for delievery",
        "batchid": "34163609",
        "batch_dtl": [
            {
                "mobileno": "8010551055",
                "msgid": "10823108",
                "status": "AWAITED-DLR"
            }
        ]
    }
}

OTP

POST Validate OTP

http://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&action=generateloginotp&mobileno=8010551055&mobileno=8010551055&code=3167

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

validateloginotp

Action

mobileno

8010551055

Mobile number

otp

3167

OTP entered by the user

Example Request

Example Response

200 – OK
{
    "status": "success",
    "description": {
        "desc": "Code does not match."
    }
}

Example Response

200 – OK
{
    "status": "success",
    "description": {
        "desc": "Code Matched successfully."
    },
	"response_code":200,
	"data":{"email":"smsalert@gmail.com","password":"123456"}
}

OTP

POST Validate OTP

http://smsalert.myshopify.com/apps/sa/authenticate.php?user=smsalert&pwd=123456&customer%5Bemail%5D=smsalert123adasf%40gmail.com&customer%5Bpassword%5D=123456&customer%5Bphone%5D=8010551045&action=validateregotp&mobileno=8010551045&otp=7971

params

user

smsalert

SMS Alert username

pwd

123456

SMS Alert password

action

validateregotp

Action

mobileno

8010551055

Mobile number

customer[email]

smsalert@gmail.com

Customer emailid

customer[phone]

8010551055

Customer phone

customer[password]

123456

Customer password

otp

3167

OTP entered by the user

Example Request

Example Response

200 – OK
{
    "status": "success",
    "description": {
        "desc": "Code does not match."
    }
}

Example Response

200 – OK
{
    "status": "success",
    "description": {
        "desc": "Code Matched successfully."
    },
	"response_code":200,
	"data":{"email":"smsalert@gmail.com","password":"123456"}
}
FAQ’S
  1. 1. What is the “Shopify Developers API” mentioned in the article?

    It refers to SMS Alert’s API offering which allows merchants using Shopify to send SMS notifications (order updates, reminders, alerts) via their store’s workflow. The API is separate from the standard Shopify store integration.

  2. 2. How much does it cost to access the Shopify Developers API?

    According to the article, the Shopify API from SMS Alert is available at a fixed cost of US $5 per month.

  3. 3. What is the first step to use the API?

    You must first subscribe to the service via your Shopify store’s SMS Alert dashboard under the API section. Only after subscription can you get the API credentials and start using it.

  4. 4. What kinds of use-cases does this API enable for Shopify stores?

    Some typical use-cases:
    – Sending SMS when a new order is placed.
    – Sending SMS on shipment / delivery of items.
    – Custom notifications triggered by store events via Shopify webhooks + this API.
    The broader knowledge-base also mentions integrating SMS Alert with Shopify to send real-time updates.

  5. 5. Does the article refer to any prerequisites or developer knowledge needed?

    While not fully detailed in the FAQ article, since it’s an API, you’ll likely need:
    – Your Shopify store’s API or webhook setup (to detect events).
    – SMS Alert API credentials, and ability to make HTTP calls from your backend or automation platform.
    – Understanding of how to map store events to SMS templates.
    The article suggests that using the API is for “developers” or stores with custom workflow needs.

  6. 6. Is this API mandatory if I already use the standard SMS Alert Shopify plugin?

    No — if you’re using the standard plugin/integration that SMS Alert offers for Shopify stores (for automated order notifications, etc.), you may not need the developer API. The Developer API is for more customised use-cases beyond what the plugin provides. (The knowledge-base has a separate integration article for the plugin: “Integrate with Shopify”).

  7. 7. Where can I find further documentation or start using the API?

    You should visit the Shopify Developers API article in the SMS Alert knowledge-base (the article you referenced) for details of subscription, endpoint information, and usage. Also check the “Integrate with Shopify” guide for context.

0

Still can't find the solution for your Query?

Contact Support