Jump to

• Request
• Response

Add a shipment to one or more shipment groups

post

/custom-actions/addToGroup/shipments/{shipment id}

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

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

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

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

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/addToGroupResultItem"
                    }
                },
                "failed":{
                    "description":"The type of the shipment group to find or create.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/addToGroupResultItemWithError"
                    }
                }
            }
        }
    ]
}

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/addToGroupResultItem"
            }
        },
        "failed":{
            "description":"The type of the shipment group to find or create.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/addToGroupResultItemWithError"
            }
        }
    }
}

Nested Schema : failed

Type: array

The type of the shipment group to find or create.

Show Source

• Array of: addToGroupResultItemWithError

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

Nested Schema : passed

Type: array

The type of the shipment group to find or create.

Show Source

• Array of: object addToGroupResultItem

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

Nested Schema : addToGroupResultItemWithError

Match All

Show Source

• object addToGroupResultItem
• object addToGroupResultItemWithError-allOf[1]

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

Nested Schema : addToGroupResultItem

Type: object

Show Source

• shipGroupPk: string
  Target shipment group.
• shipmentPk: string
  The primary key for the shipment.

{
    "properties":{
        "shipmentPk":{
            "description":"The primary key for the shipment.",
            "type":"string"
        },
        "shipGroupPk":{
            "description":"Target shipment group.",
            "type":"string"
        }
    }
}

Nested Schema : addToGroupResultItemWithError-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"
        }
    }
}

Back to Top