Jump to

• Request
• Response

Add multiple shipments to one or more shipment groups

post

/custom-actions/addToGroup/shipments/

Request

Header Parameters

• Prefer:
  An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object actionRequest
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionRequest"
        },
        {
            "type":"object",
            "properties":{
                "shipGroupPks":{
                    "description":"The type of the shipment group to find or create.",
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "required":[
                "shipGroupPks"
            ]
        }
    ]
}

Nested Schema : actionRequest

Type: object

Show Source

• pks: array pks
  Object primary keys that supports one or more multi-part (compound) keys
• reasonCodeGid: string
  A code describing the reason for the action.
• responsiblePartyGid: string
  Describes the person or people that will be affected by the action.
• statusCodeGid: string
  A code associated with the action to be performed.

{
    "properties":{
        "responsiblePartyGid":{
            "description":"Describes the person or people that will be affected by the action.",
            "type":"string"
        },
        "statusCodeGid":{
            "description":"A code associated with the action to be performed.",
            "type":"string"
        },
        "reasonCodeGid":{
            "description":"A code describing the reason for the action.",
            "type":"string"
        },
        "pks":{
            "description":"Object primary keys that supports one or more multi-part (compound) keys",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : type

Type: object

Show Source

• shipGroupPks(required): array shipGroupPks
  The type of the shipment group to find or create.

{
    "type":"object",
    "properties":{
        "shipGroupPks":{
            "description":"The type of the shipment group to find or create.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "shipGroupPks"
    ]
}

Nested Schema : pks

Type: array

Object primary keys that supports one or more multi-part (compound) keys

Show Source

• Array of: array items

{
    "description":"Object primary keys that supports one or more multi-part (compound) keys",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : shipGroupPks

Type: array

The type of the shipment group to find or create.

Show Source

• Array of: string

{
    "description":"The type of the shipment group to find or create.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Default Response.

Body ()

Root Schema : addToGroupResponse

Match All

Show Source

• object actionResponse
• object addToGroupResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionResponse"
        },
        {
            "type":"object",
            "properties":{
                "passed":{
                    "description":"The type of the shipment group to find or create.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/resultItem"
                    }
                },
                "failed":{
                    "description":"The type of the shipment group to find or create.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/resultItemWithError"
                    }
                }
            }
        }
    ]
}

Nested Schema : actionResponse

Type: object

Show Source

• success: string
  Success or failure.

{
    "properties":{
        "success":{
            "description":"Success or failure.",
            "type":"string"
        }
    }
}

Nested Schema : addToGroupResponse-allOf[1]

Type: object

Show Source

• failed: array failed
  The type of the shipment group to find or create.
• passed: array passed
  The type of the shipment group to find or create.

{
    "type":"object",
    "properties":{
        "passed":{
            "description":"The type of the shipment group to find or create.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resultItem"
            }
        },
        "failed":{
            "description":"The type of the shipment group to find or create.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resultItemWithError"
            }
        }
    }
}

Nested Schema : failed

Type: array

The type of the shipment group to find or create.

Show Source

• Array of: resultItemWithError

{
    "description":"The type of the shipment group to find or create.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/resultItemWithError"
    }
}

Nested Schema : passed

Type: array

The type of the shipment group to find or create.

Show Source

• Array of: object resultItem

{
    "description":"The type of the shipment group to find or create.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/resultItem"
    }
}

Nested Schema : resultItemWithError

Match All

Show Source

• object resultItem
• object resultItemWithError-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/resultItem"
        },
        {
            "type":"object",
            "properties":{
                "error":{
                    "description":"Error trying to add shipment to the target group.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : resultItem

Type: object

Show Source

• endTime: endTime
  The end time.
• equipmentGroup: string
  The equipment group.
• rateOffering: string
  The rate offering.
• serviceProviderID: string
  The service provider ID.
• shipmentPk: string
  The primary key for the shipment.
• startTime: startTime
  The start time.
• totalActualCost: totalActualCost
  The total actual cost.
• totalWeightedCost: totalWeightedCost
  The total weighted cost.
• transportMode: string
  The transport mode.

{
    "properties":{
        "shipmentPk":{
            "description":"The primary key for the shipment.",
            "type":"string"
        },
        "totalActualCost":{
            "description":"The total actual cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "totalWeightedCost":{
            "description":"The total weighted cost.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "startTime":{
            "description":"The start time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endTime":{
            "description":"The end time.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "serviceProviderID":{
            "description":"The service provider ID.",
            "type":"string"
        },
        "transportMode":{
            "description":"The transport mode.",
            "type":"string"
        },
        "rateOffering":{
            "description":"The rate offering.",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"The equipment group.",
            "type":"string"
        }
    }
}

Nested Schema : resultItemWithError-allOf[1]

Type: object

Show Source

• error: string
  Error trying to add shipment to the target group.

{
    "type":"object",
    "properties":{
        "error":{
            "description":"Error trying to add shipment to the target group.",
            "type":"string"
        }
    }
}

Nested Schema : endTime

The end time.

Match All

Show Source

• object dateTimeType

{
    "description":"The end time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : startTime

The start time.

Match All

Show Source

• object dateTimeType

{
    "description":"The start time.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : totalActualCost

The total actual cost.

Match All

Show Source

• object currencyType

{
    "description":"The total actual cost.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : totalWeightedCost

The total weighted cost.

Match All

Show Source

• object currencyType

{
    "description":"The 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"
        }
    }
}

Back to Top