Get the Consignment Detail XLSX for a consignment

​

Path Parameters

  • consignmentId
    Type: stringFormat: uuid
    required

Query Parameters

  • IncludeShipping
    Type: boolean

    Whether to include shipping information in the XLSX document, if any. Defaults to true.

  • IncludeMetrics
    Type: boolean

    Whether to include metrics in the XLSX document. Defaults to true.

  • IncludeNotes
    Type: boolean

    Whether to include notes in the XLSX document, if any. Defaults to true.

  • IncludeProductSummary
    Type: boolean

    Whether to include product summary information in the XLSX document. Defaults to true.

  • SplitIntoMultipleWorksheets
    Type: boolean

    Whether to split each section into separate worksheets in the XLSX document. Defaults to false.

Responses

  • 200

    OK

Request Example for get/v1/consignments/{consignmentId}/detail-xlsx
curl https://api.consignlyhq.com/v1/consignments/123e4567-e89b-12d3-a456-426614174000/detail-xlsx
No Body

OK