Jump to

• Request
• Response

Generate shipments on a ground schedule in an ad hoc manner

post

/custom-actions/forceGenerateShipments/repetitionSchedules/{repetitionScheduleID}

Request

Path Parameters

• repetitionScheduleID(required): string
  The Repitition Schedule ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request parameters to generate shipments on a ground schedule in an ad hoc manner.

Show Source

• date: string
  Date for which ground schedule shipments will be generated.
• numberOfShipments: integer
  Number of ground schedule shipments to be generated.

{
    "description":"Request parameters to generate shipments on a ground schedule in an ad hoc manner.",
    "type":"object",
    "properties":{
        "date":{
            "description":"Date for which ground schedule shipments will be generated.",
            "type":"string"
        },
        "numberOfShipments":{
            "description":"Number of ground schedule shipments to be generated.",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success! A successful POST method returns a 200 status code.

Body ()

Root Schema : forceGenerateShipmentsResponse

Type: object

Response of generated ground schedule shipments.

Show Source

• cutoffDateUsed: boolean
  Is the cut off time used. If not start time is used.
• domainName: string
  Generated ground schedule shipments domain.
• durationInDays: integer
  Number of days to generate shipments.
• generationEndDate: string
  Shipments generation end date/time.
• generationStartDate: string
  Shipments generation start date/time.
• groundScheduleGenerationId: string
  Ground schedule shipment generation result GID.
• processEndTime: string
  Generation process end time.
• processStartTime: string
  Generation process start time.
• queryName: string
  Query Name
• shipments: array shipments
  List of generated shipment IDs.
• shipmentsBuilt: string
  Number of shipments generated.
• shipmentsExpected: string
  Number of shipments expected to be generated.

{
    "description":"Response of generated ground schedule shipments.",
    "type":"object",
    "properties":{
        "groundScheduleGenerationId":{
            "description":"Ground schedule shipment generation result GID.",
            "type":"string"
        },
        "processStartTime":{
            "description":"Generation process start time.",
            "type":"string"
        },
        "processEndTime":{
            "description":"Generation process end time.",
            "type":"string"
        },
        "domainName":{
            "description":"Generated ground schedule shipments domain.",
            "type":"string"
        },
        "shipmentsExpected":{
            "description":"Number of shipments expected to be generated.",
            "type":"string"
        },
        "shipmentsBuilt":{
            "description":"Number of shipments generated.",
            "type":"string"
        },
        "shipments":{
            "description":"List of generated shipment IDs.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "cutoffDateUsed":{
            "description":"Is the cut off time used. If not start time is used.",
            "type":"boolean"
        },
        "durationInDays":{
            "description":"Number of days to generate shipments.",
            "type":"integer"
        },
        "queryName":{
            "description":"Query Name",
            "type":"string"
        },
        "generationStartDate":{
            "description":"Shipments generation start date/time.",
            "type":"string"
        },
        "generationEndDate":{
            "description":"Shipments generation end date/time.",
            "type":"string"
        }
    }
}

Nested Schema : shipments

Type: array

List of generated shipment IDs.

Show Source

• Array of: string

{
    "description":"List of generated shipment IDs.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

401 Response

Unauthorized, the request was not successful because it lacks valid authentication credentials for the requested resource.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

403 Response

Access to the specified resource has been forbidden.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top