Jump to

• Request
• Response

Change Start Time

post

/custom-actions/changeStartTime/shipments/

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• isFixed: boolean
  Overrides the previous constraints on the original shipment start time.
• offSetDuration: string
  Start Time Offset Duration in seconds.
• resetOrderTimeWindows: boolean
  Affects all order releases and their associated order bases for the shipment. Changes the time window emphasis of these order releases to NONE before attempting to change the start time
• shipmentGid: string
  The shipment must be identified using a shipment GID.
• startDateTime: string
  The start time of the shipment in a YYYY-MM-DDTHH:mm:ss+hh:mm (e.g., 2023-10-27T14:00:00+05:30) format.

{
    "description":"",
    "type":"object",
    "properties":{
        "shipmentGid":{
            "description":"The shipment must be identified using a shipment GID.",
            "type":"string"
        },
        "startDateTime":{
            "description":"The start time of the shipment in a YYYY-MM-DDTHH:mm:ss+hh:mm (e.g., 2023-10-27T14:00:00+05:30) format.",
            "type":"string"
        },
        "offSetDuration":{
            "description":"Start Time Offset Duration in seconds.",
            "type":"string"
        },
        "isFixed":{
            "description":"Overrides the previous constraints on the original shipment start time.",
            "type":"boolean"
        },
        "resetOrderTimeWindows":{
            "description":"Affects all order releases and their associated order bases for the shipment. Changes the time window emphasis of these order releases to NONE before attempting to change the start time",
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful.

Body ()

Root Schema : changeStartTimeResponse

Type: object

Show Source

• actualCostOfShipment: string
  The actual cost of the shipment.
• isFeasible: boolean
  Indicates if the new start time is feasible.
• newStartDateTime: string
  The new start time of the shipment in YYYY-MM-DDTHH:mm:ss+hh:mm (e.g., 2023-10-27T14:00:00+05:30) format.
• shipmentGid: string
  The shipment must be identified using a shipment GID.

{
    "description":"",
    "type":"object",
    "properties":{
        "isFeasible":{
            "description":"Indicates if the new start time is feasible.",
            "type":"boolean"
        },
        "shipmentGid":{
            "description":"The shipment must be identified using a shipment GID.",
            "type":"string"
        },
        "newStartDateTime":{
            "description":"The new start time of the shipment in YYYY-MM-DDTHH:mm:ss+hh:mm (e.g., 2023-10-27T14:00:00+05:30) format.",
            "type":"string"
        },
        "actualCostOfShipment":{
            "description":"The actual cost of the shipment. ",
            "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 or a missing required value.

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 the 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 is 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