Jump to

• Request
• Response

Performs the Change Service Provider action for a shipment

post

/custom-actions/changeServiceProvider/shipments/

Request

Header Parameters

• Prefer: string
  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 schema
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionRequest"
        },
        {
            "type":"object",
            "properties":{
                "rateGeoGid":{
                    "description":"Rate geo GID.",
                    "type":"string"
                },
                "equipmentGroup":{
                    "description":"The equipment group.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : schema

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

• equipmentGroup: string
  The equipment group.
• rateGeoGid: string
  Rate geo GID.

{
    "type":"object",
    "properties":{
        "rateGeoGid":{
            "description":"Rate geo GID.",
            "type":"string"
        },
        "equipmentGroup":{
            "description":"The equipment group.",
            "type":"string"
        }
    }
}

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default response.

Body ()

Root Schema : changeServiceProviderResponse

Match All

Show Source

• object actionResponse
• object changeServiceProviderResponse-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/actionResponse"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "description":"The Change Service Provider action response for a shipment.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/resultItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : actionResponse

Type: object

Show Source

• success: string
  Success or failure.

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

Nested Schema : changeServiceProviderResponse-allOf[1]

Type: object

Show Source

• items: array items
  The Change Service Provider action response for a shipment.

{
    "type":"object",
    "properties":{
        "items":{
            "description":"The Change Service Provider action response for a shipment.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

The Change Service Provider action response for a shipment.

Show Source

• Array of: object resultItem

{
    "description":"The Change Service Provider action response for a shipment.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/resultItem"
    }
}

Nested Schema : resultItem

Type: object

Show Source

• shipGroupPk: string
  Target shipment group.
• shipmentPk: string
  Pk of the shipment for the target group.

{
    "properties":{
        "shipmentPk":{
            "description":"Pk of the shipment for the target group.",
            "type":"string"
        },
        "shipGroupPk":{
            "description":"Target shipment group.",
            "type":"string"
        }
    }
}

Back to Top