The ShopSynch API follows RESTful principles and uses conventional HTTP response codes to indicate the success or failure of requests.

HTTP Codes

200 - OK

The request was successful, and the intended action was executed correctly. This applies to retrieving products, processing orders, and updating customer details.

201 - Created

A new resource has been successfully created. This is typically returned when a new order, product, or customer profile is added to the system.

400 - Bad Request

The request was invalid due to incorrect parameters, missing required fields, or improperly formatted data. This may occur when attempting to create an order without specifying necessary details.

401 - Unauthorized

Authentication failed or was not provided. This happens when an invalid API key or JWT token is passed in the Authorization header or when a request is made without proper authentication.

422 - Unprocessable Entity

Validation failed. This happens when you submit data that does not pass the required checks.

404 - Not Found

The requested resource does not exist. This may occur when trying to access a product, order, or customer that has been deleted or never existed.

5xx - Server Errors

An unexpected error occurred on the server, preventing the request from being processed. If this happens, please report it immediately, as it may indicate a system issue.

Handling Errors

Ensure that your application properly handles errors by checking response status codes and implementing retry logic where appropriate. For authentication failures, verify that the API key or JWT token is valid and included in the request headers.

Error Reference

Promotion Errors

HTTP Status	Error Code	Description
400	INVALID_DISCOUNT_TYPE	Unknown value passed for discountType
400	DISCOUNT_VALUE_REQUIRED	discountValue missing for PERCENTAGE or FLAT_AMOUNT
400	QUANTITY_FIELDS_REQUIRED	requiredQuantity or freeQuantity missing for BUY_X_GET_Y
400	END_DATE_BEFORE_START_DATE	endDate is before startDate
400	INVALID_STATUS_TRANSITION	Attempted an unsupported status transition
400	CANNOT_SET_DEPLETED_STATUS	DEPLETED cannot be set manually
409	PROMOTION_CODE_ALREADY_EXISTS	A promotion with that code already exists for your tenant

Order / Checkout Errors

HTTP Status	Error Code	Description
400	PROMOTION_NOT_ACTIVE	The promotion code exists but is not currently active
400	PROMOTION_MINIMUM_NOT_MET	Order subtotal is below the promotion's minimumOrderValue
400	PROMOTION_USAGE_LIMIT_REACHED	The promotion has been fully redeemed
400	PROMOTION_CUSTOMER_LIMIT_REACHED	This customer has already used this promotion the maximum number of times
404	PROMOTION_NOT_FOUND	No promotion found for the provided code
409	PROMOTION_ALREADY_APPLIED	A promotion has already been applied to this order

Next Steps

• Learn more about Authentication