previewBidHistoryImport

Requires permission biddesk:settings:manage.

What an import would do: row counts, rows with problems, and the SKUs and customers not found. Writes nothing. Requires Bid Desk and permission to manage Bid Desk settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PreviewBidHistoryImport($input: BidHistoryImportInput!) {
  previewBidHistoryImport(input: $input) {
    alreadyImported
    previewHash
    bids {
      invalid
      total
      valid
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PreviewBidHistoryImport($input: BidHistoryImportInput!) {\n  previewBidHistoryImport(input: $input) {\n    alreadyImported\n    previewHash\n    bids {\n      invalid\n      total\n      valid\n    }\n  }\n}",
  "variables": {
    "input": {
      "bidMapping": [
        {
          "field": "string",
          "header": "string"
        }
      ],
      "bidsSheet": "string",
      "fileKey": "string",
      "lineMapping": [
        {
          "field": "string",
          "header": "string"
        }
      ]
    }
  }
}
EOF

Variables:

{
  "input": {
    "bidMapping": [
      {
        "field": "string",
        "header": "string"
      }
    ],
    "bidsSheet": "string",
    "fileKey": "string",
    "lineMapping": [
      {
        "field": "string",
        "header": "string"
      }
    ]
  }
}

Response:

{
  "data": {
    "previewBidHistoryImport": {
      "alreadyImported": 0,
      "previewHash": "string",
      "bids": {
        "invalid": 0,
        "total": 0,
        "valid": 0
      }
    }
  }
}

previewBidHistoryImport(
  input: BidHistoryImportInput!
): BidHistoryPreview!

Arguments

previewBidHistoryImport.input ● BidHistoryImportInput! non-null input

The sheets and column mappings to preview.

Type

BidHistoryPreview object

What a history import would do, before anything is written.