Jump to

• Request
• Response

Generate shipments on a ground schedule in an ad hoc manner.

post

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

Request

There are no request parameters for this operation.

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.
• Number Of Shipments: 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"
        },
        "Number Of Shipments":{
            "description":"Number of ground schedule shipments to be generated",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default Response.

Body ()

Root Schema : forceGenerateShipmentsResponse

Type: object

Response of generated ground schedule shipments.

Show Source

• Cutoff Date Used: boolean
  Is the cut off time used. If not Start Time is used
• Domain Name: string
  Generated ground schedule shipments domain
• Duration(days): integer
  Number of days to generate shipments
• Generation End Date: string
  Shipments generation end date/time
• Generation Start Date: string
  Shipments generation start date/time
• Ground Schedule Generation ID: string
  Ground schedule shipment generation result GID
• Process End Time: string
  Generation process end time
• Process Start Time: string
  Generation process start time
• Query Name: string
  Query Name
• Shipments: array Shipments
  List of generated shipment ids
• Shipments Built: string
  Number of shipments generated
• Shipments Expected: string
  Number of shipments expected to be generated

{
    "description":"Response of generated ground schedule shipments.",
    "type":"object",
    "properties":{
        "Ground Schedule Generation ID":{
            "description":"Ground schedule shipment generation result GID",
            "type":"string"
        },
        "Process Start Time":{
            "description":"Generation process start time",
            "type":"string"
        },
        "Process End Time":{
            "description":"Generation process end time",
            "type":"string"
        },
        "Domain Name":{
            "description":"Generated ground schedule shipments domain",
            "type":"string"
        },
        "Shipments Expected":{
            "description":"Number of shipments expected to be generated",
            "type":"string"
        },
        "Shipments Built":{
            "description":"Number of shipments generated",
            "type":"string"
        },
        "Shipments":{
            "description":"List of generated shipment ids",
            "type":"array"
        },
        "Cutoff Date Used":{
            "description":"Is the cut off time used. If not Start Time is used",
            "type":"boolean"
        },
        "Duration(days)":{
            "description":"Number of days to generate shipments",
            "type":"integer"
        },
        "Query Name":{
            "description":"Query Name",
            "type":"string"
        },
        "Generation Start Date":{
            "description":"Shipments generation start date/time",
            "type":"string"
        },
        "Generation End Date":{
            "description":"Shipments generation end date/time",
            "type":"string"
        }
    }
}

Nested Schema : Shipments

Type: array

List of generated shipment ids

400 Response

Error Response.

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