Set up sporadic pickup settings

POST /carrier/sporadic-pick-up
Api key auth

Configure sporadic pickup settings. This endpoint allows carriers to manage settings for sporadic pickups, enabling flexibility in pickup scheduling.

application/json

Body Required

  • schedule string

    Schedule for sporadic pickups

Responses

  • 200 application/json

    Sporadic pickup settings configured successfully

    Hide response attribute Show response attribute object
    • status string

      Status message
  • 401 application/json

    Unauthorized. The request is missing valid authentication credentials.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating lack of authorization
  • 400 application/json

    Bad Request. The request is malformed or missing required parameters.

    Hide response attribute Show response attribute object
    • error string

      Error message detailing the cause of the bad request
  • 500 application/json

    Internal Server Error. An unexpected error occurred on the server.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating an internal server error
POST /carrier/sporadic-pick-up 
curl \
 --request POST 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/carrier/sporadic-pick-up' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"schedule":"string"}'
Request examples 
{
  "schedule": "string"
}
Response examples (200) 
{
  "status": "Sporadic pickup settings have been configured successfully"
}
Response examples (401) 
{
  "error": "Unauthorized"
}
Response examples (400) 
{
  "error": "Invalid request. Check parameters and try again."
}
Response examples (500) 
{
  "error": "Internal Server Error"
}