ShopWired's API

ShopWired offers an advanced AI-powered assistant, designed to provide instant support and guidance on every aspect of the ShopWired API. Powered by GPT technology, this AI has been trained on the entire API help guide, including all endpoint documentation, usage examples, and best practices.

The AI can provide comprehensive, real-time assistance helping with:

• Understanding API endpoints – Get detailed explanations of each API endpoint, including request and response structures, parameters, and authentication methods
• Code examples – Request example code in multiple languages for common API tasks such as creating, retrieving, updating, or deleting resources
• Troubleshooting – Receive guidance on resolving common API errors and issues
• Best practices – Learn about recommended approaches for integrating with the ShopWired API
• Webhooks and authentication – Get help with configuring webhooks, verifying signatures, and handling authentication

The AI can be accessed at https://tinyurl.com/shopwired-api-ai

The ShopWired API adheres to REST principles and supports the following features:

• HTTP Authentication: All requests require valid authentication
• HTTP Verbs: Use standard methods such as GET, POST, PUT, and DELETE
• JSON Responses: All responses are provided in JSON format
• HTTPS Only: All requests must be sent over HTTPS; non-secure HTTP requests will be rejected
• Content-Type: PUT and POST requests must specify application/json as the Content-Type

The ShopWired API uses standard HTTP status codes to indicate success or failure:

• 2xx: Successful requests
• 4xx: Client errors (e.g., invalid parameters, authentication errors)
• 5xx: Server errors

• 200 OK – Successful request
• 201 Created – Resource created successfully
• 204 No Content – Request successful but no content is returned
• 400 Bad Request – Incorrect API usage
• 401 Unauthorized – Invalid or missing authentication credentials
• 404 Not Found – The requested resource does not exist
• 405 Method Not Allowed – The HTTP method is not supported
• 415 Unsupported Media Type – Missing or incorrect Content-Type
• 422 Unprocessable Entity – Validation errors
• 429 Too Many Requests – Rate limit exceeded
• 500 Internal Server Error – Server-side error

Most list endpoints support pagination using the following query parameters:

• count: The number of records to retrieve (default: 50, max: 100)
• offset: The number of records to skip

Example request:

GET /products?count=50&offset=100

Use the embed query parameter to include related objects within a response.

For example, to include parent categories when listing categories:

GET /categories?embed=parents

ShopWired uses the leaky bucket algorithm for rate limiting:

• Bucket Size: 40 requests
• Leak Rate: 2 requests per second
• Burst Capability: Temporary bursts of requests are allowed as long as the average rate remains at 2 requests per second

To avoid 429 Too Many Requests errors:

• Monitor the x-rate-limit-limit value in the response header
• Monitor the x-rate-limit-remaining value in the response header
• Ensure your app does not reach an x-rate-limit-remaining value of 0 by preventing your app from consistently exceeding 2 requests per second
• Handle 429 responses with appropriate retry logic once the x-rate-limit-remaining value is positive

• Always authenticate your requests
• Use HTTPS to ensure security
• Handle errors gracefully by checking response codes
• Use pagination to manage large datasets
• Apply fields and embed parameters to optimise responses