Jump to

• Request
• Response

Perform the Secure Resources action for a shipment

post

/custom-actions/secureResources/tenders/{shipmentId}

Request

Path Parameters

• shipmentId(required): string
  Shipment GID

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. Shipment tendered successfully.

Body ()

Root Schema : secureResourcesResponse

Type: object

Response after secure resources the shipment.

Show Source

• items: array items
  Secure Resources response for tender.

{
    "description":"Response after secure resources the shipment.",
    "type":"object",
    "properties":{
        "items":{
            "description":"Secure Resources response for tender.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Secure Resources response for tender.

Show Source

• Array of: object resultItem
  Response after withdraw the tender.

{
    "description":"Secure Resources response for tender.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/resultItem"
    }
}

Nested Schema : resultItem

Type: object

Response after withdraw the tender.

Show Source

• domainName: string
  Domain Name
• endTime: endTime
  End Time
• rateOffering: string
  Rate Offering
• serviceProviderID: string
  Service Provider ID
• shipmentPk: string
  Pk of the shipment
• startTime: startTime
  Start Time
• totalActualCost: totalActualCost
  Total Actual Cost
• totalWeightedCost: totalWeightedCost
  Total Weighted Cost

{
    "description":"Response after withdraw the tender.",
    "type":"object",
    "properties":{
        "shipmentPk":{
            "description":"Pk of the shipment",
            "type":"string"
        },
        "totalActualCost":{
            "description":"Total Actual Cost",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"Total Weighted Cost",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"Start Time",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"End Time",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "serviceProviderID":{
            "description":"Service Provider ID",
            "type":"string"
        },
        "rateOffering":{
            "description":"Rate Offering",
            "type":"string"
        },
        "domainName":{
            "description":"Domain Name",
            "type":"string"
        }
    }
}

Nested Schema : endTime

End Time

Match All

End Time

Show Source

• object dateTimeType

{
    "description":"End Time",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : startTime

Start Time

Match All

Start Time

Show Source

• object dateTimeType

{
    "description":"Start Time",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : totalActualCost

Total Actual Cost

Match All

Total Actual Cost

Show Source

• object currencyType

{
    "description":"Total Actual Cost",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalWeightedCost

Total Weighted Cost

Match All

Total Weighted Cost

Show Source

• object currencyType

{
    "description":"Total Weighted Cost",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

400 Response

Bad Request. The server could not understand the request due to invalid syntax or parameters.

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. Authentication is required and has failed or has not yet been provided.

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

Forbidden. 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

Internal Server Error. The server encountered an internal error that prevented it from fulfilling this 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