REST API for Fusion Cloud Transportation and Global Trade Management Business Object Resources

Get service provider options for a shipment

post

/custom-actions/getServiceProviderOptions/shipments/{shipmentId}

Request

Path Parameters

shipmentId(required): string

Shipment GID

Supported Media Types

application/json

Root Schema : schema

Type: object

Request body for service provider options (optional).

Show Source

pks: array pks

Array of shipment PKs when not using path id.
ratePreference: string

If not provided, the value will depend on the property glog.webserver.shipment.changeSP.showpreferredOnly.
relaxEquipment: string

If not provided, the value will depend on the property glog.webserver.shipment.changeSP.ignoreEquipment.
relaxMode: string

If not provided, the value will depend on the property glog.webserver.shipment.changeSP.ignoreMode.
relaxServiceTime: string

If not provided, the value will depend on the property glog.webserver.shipment.changeSP.ignoreServiceTime.
showDigitalFreightRates: string

If not provided, the value will depend on the property glog.webserver.shipment.changeSP.showDigitalFreightRates.

{
    "description":"Request body for service provider options (optional).",
    "type":"object",
    "properties":{
        "pks":{
            "description":"Array of shipment PKs when not using path id.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "relaxEquipment":{
            "description":"If not provided, the value will depend on the property glog.webserver.shipment.changeSP.ignoreEquipment.",
            "type":"string"
        },
        "relaxMode":{
            "description":"If not provided, the value will depend on the property glog.webserver.shipment.changeSP.ignoreMode.",
            "type":"string"
        },
        "relaxServiceTime":{
            "description":"If not provided, the value will depend on the property glog.webserver.shipment.changeSP.ignoreServiceTime.",
            "type":"string"
        },
        "ratePreference":{
            "description":"If not provided, the value will depend on the property glog.webserver.shipment.changeSP.showpreferredOnly.",
            "type":"string"
        },
        "showDigitalFreightRates":{
            "description":"If not provided, the value will depend on the property glog.webserver.shipment.changeSP.showDigitalFreightRates.",
            "type":"string"
        }
    }
}

Nested Schema : pks

Type: array

Array of shipment PKs when not using path id.

Show Source

Array of: string

{
    "description":"Array of shipment PKs when not using path id.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

OK. Service provider options returned.

Root Schema : getServiceProviderOptionsResponse

Type: object

Response containing service provider options for the shipment.

Show Source

firstOrderReleaseGid: string

First Order Release GID
items: array items

List of service provider options.
shipmentPk: string

Pk of the shipment

{
    "description":"Response containing service provider options for the shipment.",
    "type":"object",
    "properties":{
        "items":{
            "description":"List of service provider options.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/getServiceProviderOptionsResultItem"
            }
        },
        "shipmentPk":{
            "description":"Pk of the shipment",
            "type":"string"
        },
        "firstOrderReleaseGid":{
            "description":"First Order Release GID",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

List of service provider options.

Show Source

Array of: object getServiceProviderOptionsResultItem

Service provider option for the shipment

{
    "description":"List of service provider options.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/getServiceProviderOptionsResultItem"
    }
}

Nested Schema : getServiceProviderOptionsResultItem

Type: object

Service provider option for the shipment

Show Source

capacityUsage: capacityUsage

Capacity Usage Details
co2Emission: co2Emission

CO2 Emissions Details
co2EqEmission: co2EqEmission

CO2 Equivalent Emissions Details
commitmentAllocation: commitmentAllocation

Commitment Allocation Details
commitmentCount: commitmentCount

Commitment Count Details
destinationLocationGid: string

Destination Location Gid
endTime: endTime

End Time
equipmentGroupGid: string

Equipment Group Gid
isDigitalFreight: string

Indicates whether this service provider is a digital freight provider.
isServiceTimeFeasible: string

Indicates whether the service time is feasible.
isServProvPreferred: string

Indicates whether the preferred service provider selected.
rateGeoGid: string

Rate Geo Gid
rateOfferingGid: string

Rate Offering Gid
serviceProviderId: string

Service Provider Id
sourceLocationGid: string

Source Location Gid
startTime: startTime

Start Time
tenderStatus: string

Indicates current tender status
totalCost: totalCost

Total Cost
totalWeightedCost: totalWeightedCost

Total Weighted Cost
transportModeGid: string

Transport Mode Gid

{
    "description":"Service provider option for the shipment",
    "type":"object",
    "properties":{
        "serviceProviderId":{
            "description":"Service Provider Id",
            "type":"string"
        },
        "transportModeGid":{
            "description":"Transport Mode Gid",
            "type":"string"
        },
        "rateOfferingGid":{
            "description":"Rate Offering Gid",
            "type":"string"
        },
        "rateGeoGid":{
            "description":"Rate Geo Gid",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"Equipment Group Gid",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"Source Location Gid",
            "type":"string"
        },
        "destinationLocationGid":{
            "description":"Destination Location Gid",
            "type":"string"
        },
        "isServiceTimeFeasible":{
            "description":"Indicates whether the service time is feasible.",
            "type":"string"
        },
        "isServProvPreferred":{
            "description":"Indicates whether the preferred service provider selected.",
            "type":"string"
        },
        "isDigitalFreight":{
            "description":"Indicates whether this service provider is a digital freight provider.",
            "type":"string"
        },
        "tenderStatus":{
            "description":"Indicates current tender status",
            "type":"string"
        },
        "totalCost":{
            "description":"Total 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"
                }
            ]
        },
        "commitmentAllocation":{
            "description":"Commitment Allocation Details",
            "allOf":[
                {
                    "$ref":"#/components/schemas/commitmentAllocationType"
                }
            ]
        },
        "commitmentCount":{
            "description":"Commitment Count Details",
            "allOf":[
                {
                    "$ref":"#/components/schemas/commitmentCountType"
                }
            ]
        },
        "capacityUsage":{
            "description":"Capacity Usage Details",
            "allOf":[
                {
                    "$ref":"#/components/schemas/capacityUsageType"
                }
            ]
        },
        "co2Emission":{
            "description":"CO2 Emissions Details",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "co2EqEmission":{
            "description":"CO2 Equivalent Emissions Details",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        }
    }
}

Nested Schema : capacityUsage

Capacity Usage Details

Match All

Capacity Usage Details

Show Source

object capacityUsageType

{
    "description":"Capacity Usage Details",
    "allOf":[
        {
            "$ref":"#/components/schemas/capacityUsageType"
        }
    ]
}

Nested Schema : co2Emission

CO2 Emissions Details

Match All

CO2 Emissions Details

Show Source

object amountType

{
    "description":"CO2 Emissions Details",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : co2EqEmission

CO2 Equivalent Emissions Details

Match All

CO2 Equivalent Emissions Details

Show Source

object amountType

{
    "description":"CO2 Equivalent Emissions Details",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : commitmentAllocation

Commitment Allocation Details

Match All

Commitment Allocation Details

Show Source

object commitmentAllocationType

{
    "description":"Commitment Allocation Details",
    "allOf":[
        {
            "$ref":"#/components/schemas/commitmentAllocationType"
        }
    ]
}

Nested Schema : commitmentCount

Commitment Count Details

Match All

Commitment Count Details

Show Source

object commitmentCountType

{
    "description":"Commitment Count Details",
    "allOf":[
        {
            "$ref":"#/components/schemas/commitmentCountType"
        }
    ]
}

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 : totalCost

Total Cost

Match All

Total Cost

Show Source

object currencyType

{
    "description":"Total 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 : capacityUsageType

Type: object

Show Source

capacityLimitXid: string
capacityUsageXid: string
limit: string
usage: string

{
    "type":"object",
    "properties":{
        "capacityUsageXid":{
            "type":"string"
        },
        "capacityLimitXid":{
            "type":"string"
        },
        "limit":{
            "type":"string"
        },
        "usage":{
            "type":"string"
        }
    }
}

Nested Schema : amountType

Type: object

Show Source

unit: string

Unit of measure
value: number

Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : commitmentAllocationType

Type: object

Show Source

actualValue: string
commitmentAllocationXid: string
plannedValue: string
servprovXid: string

{
    "type":"object",
    "properties":{
        "commitmentAllocationXid":{
            "type":"string"
        },
        "servprovXid":{
            "type":"string"
        },
        "plannedValue":{
            "type":"string"
        },
        "actualValue":{
            "type":"string"
        }
    }
}

Nested Schema : commitmentCountType

Type: object

Show Source

actualValue: string
commitmentXid: string
plannedValue: string
primaryCountType: string

{
    "type":"object",
    "properties":{
        "commitmentXid":{
            "type":"string"
        },
        "primaryCountType":{
            "type":"string"
        },
        "plannedValue":{
            "type":"string"
        },
        "actualValue":{
            "type":"string"
        }
    }
}

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.

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.

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.

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.

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"
    ]
}