Overview


These pages provide details in the utilization in the Verde Fulfillment API.

Base URL https://api-qa.verdefulfillmentusa.com

Authentication

The Verde API utilizes a Bearer Token HTTP authentication scheme to protect the endpoints. Each request must contain an authorization header in the form of a bearer token.

To request credentials to access the API, please contact api[at]verdefulfillmentusa.com.

Authorization: Bearer <TOKEN>

Rate limits

The API supports a limit of 30 requests per user per minute. Exceeding this will result in receiving a 429 Too Many Requests status code. If you receive this, your request has not been accepted/run and you should try again after a period of time.

    HTTP/1.1 429 Too Many Requests
    {
        "message": "rate limit exceeded: 30 per 1 minute"
    }                
                    

Status and Error Codes

Success Codes


200 OK

The request was successful.

202 Accepted

The request was accepted and will be processed shortly.

Failure Codes


400 Bad Request

Invalid request, usually do to a malformed JSON request body.


401 Unauthorized

The authorization header is either missing, or an authentication credentials.


403 Forbidden

Trying to access an endpoint without your credentials having the proper access scope.


404 Not Found

The requested resource could not be found.


429 Too Many Requests

The rate limit has been exceeded.


5xx Errors

An internal error occured in the Verde API. If you repeatedly receive a status code in the 5xx range, please reach out to support.


©2024 Verde Fulfillment USA