Jump to

• Request
• Response

Perform the Accept or Decline action for multiple Tender Groups

post

/custom-actions/acceptDeclineTenderGroup/tenders/

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request parameters for the accept or decline Tender Group action.

Show Source

• acceptanceCode(required): string
  Acceptance code A for Accept action and D for Decline action
• declineReasonCode: string
  Reason for declining the tender
• pks: array pks
  Pass the tender group ID(s) pks to perform accept/decline tender for one or more records when the tender group ID is not passed in the URL.
• refnums: object refnums
  Reference Number Qualifier and Value to be added when accepting single shipment group tender.
• remarks: object remarks
  Remarks to be added when accepting single shipment group tender.
• servprovGid: string
  Service provider ID of the Shipment Group

{
    "description":"Request parameters for the accept or decline Tender Group action.",
    "type":"object",
    "properties":{
        "acceptanceCode":{
            "description":"Acceptance code A for Accept action and D for Decline action",
            "type":"string"
        },
        "servprovGid":{
            "description":"Service provider ID of the Shipment Group",
            "type":"string"
        },
        "pks":{
            "description":"Pass the tender group ID(s) pks to perform accept/decline tender for one or more records when the tender group ID is not passed in the URL.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "declineReasonCode":{
            "description":"Reason for declining the tender",
            "type":"string"
        },
        "remarks":{
            "description":"Remarks to be added when accepting single shipment group tender.",
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "remarkQual":{
                                "type":"string",
                                "description":"Remark Qualifier GID"
                            },
                            "remarkText":{
                                "type":"string",
                                "description":"Remark Text"
                            }
                        },
                        "required":[
                            "remarkQual",
                            "remarkText"
                        ]
                    }
                }
            }
        },
        "refnums":{
            "description":"Reference Number Qualifier and Value to be added when accepting single shipment group tender.",
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "refnumQual":{
                                "type":"string",
                                "description":"Reference Number Qualifier GID"
                            },
                            "refnumValue":{
                                "type":"string",
                                "description":"Reference Number Value"
                            }
                        },
                        "required":[
                            "refnumQual",
                            "refnumValue"
                        ]
                    }
                }
            }
        }
    },
    "required":[
        "acceptanceCode"
    ]
}

Nested Schema : pks

Type: array

Pass the tender group ID(s) pks to perform accept/decline tender for one or more records when the tender group ID is not passed in the URL.

Show Source

• Array of: string

{
    "description":"Pass the tender group ID(s) pks to perform accept/decline tender for one or more records when the tender group ID is not passed in the URL.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : refnums

Type: object

Reference Number Qualifier and Value to be added when accepting single shipment group tender.

Show Source

• items: array items

{
    "description":"Reference Number Qualifier and Value to be added when accepting single shipment group tender.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "refnumQual":{
                        "type":"string",
                        "description":"Reference Number Qualifier GID"
                    },
                    "refnumValue":{
                        "type":"string",
                        "description":"Reference Number Value"
                    }
                },
                "required":[
                    "refnumQual",
                    "refnumValue"
                ]
            }
        }
    }
}

Nested Schema : remarks

Type: object

Remarks to be added when accepting single shipment group tender.

Show Source

• items: array items

{
    "description":"Remarks to be added when accepting single shipment group tender.",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "remarkQual":{
                        "type":"string",
                        "description":"Remark Qualifier GID"
                    },
                    "remarkText":{
                        "type":"string",
                        "description":"Remark Text"
                    }
                },
                "required":[
                    "remarkQual",
                    "remarkText"
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "refnumQual":{
                "type":"string",
                "description":"Reference Number Qualifier GID"
            },
            "refnumValue":{
                "type":"string",
                "description":"Reference Number Value"
            }
        },
        "required":[
            "refnumQual",
            "refnumValue"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• refnumQual(required): string
  Reference Number Qualifier GID
• refnumValue(required): string
  Reference Number Value

{
    "type":"object",
    "properties":{
        "refnumQual":{
            "type":"string",
            "description":"Reference Number Qualifier GID"
        },
        "refnumValue":{
            "type":"string",
            "description":"Reference Number Value"
        }
    },
    "required":[
        "refnumQual",
        "refnumValue"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "remarkQual":{
                "type":"string",
                "description":"Remark Qualifier GID"
            },
            "remarkText":{
                "type":"string",
                "description":"Remark Text"
            }
        },
        "required":[
            "remarkQual",
            "remarkText"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• remarkQual(required): string
  Remark Qualifier GID
• remarkText(required): string
  Remark Text

{
    "type":"object",
    "properties":{
        "remarkQual":{
            "type":"string",
            "description":"Remark Qualifier GID"
        },
        "remarkText":{
            "type":"string",
            "description":"Remark Text"
        }
    },
    "required":[
        "remarkQual",
        "remarkText"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Default Response.

Body ()

Root Schema : acceptDeclineTenderGroupResponse

Type: object

Response after accept or decline the tender group.

Show Source

• items: array items
  Accepte or Decline response for tender.

{
    "description":"Response after accept or decline the tender group.",
    "type":"object",
    "properties":{
        "items":{
            "description":"Accepte or Decline response for tender.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/resultItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Accepte or Decline response for tender.

Show Source

• Array of: object resultItem

{
    "description":"Accepte or Decline response for tender.",
    "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"
        }
    }
}

400 Response

Error Response.

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 Error Response.

Body ()

Root Schema : errorResponse500

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