Choose a version:

UrlRedirectImport

object

Requires read_online_store_navigation access scope.

A request to import a URLRedirect object into the Online Store channel. Apps can use this to query the state of an UrlRedirectImport request.

For more information, see url-redirects.

Anchor to FieldsFields

Anchor to countcount • Int: The number of rows in the file.
Anchor to createdCountcreatedCount • Int: The number of redirects created from the import.
Anchor to failedCountfailedCount • Int: The number of redirects that failed to be imported.
Anchor to finishedfinished • Boolean!non-null: Whether the import is finished.
Anchor to finishedAtfinishedAt • DateTime: The date and time when the import finished.
Anchor to idid • ID!non-null: The ID of the UrlRedirectImport object.
Anchor to previewRedirectspreviewRedirects • [UrlRedirectImportPreview!]!non-null: A list of up to three previews of the URL redirects to be imported.
Anchor to updatedCountupdatedCount • Int: The number of redirects updated during the import.

Was this section helpful?

Anchor to urlRedirectImport urlRedirectImport • query: Returns a redirect import resource by ID.

Was this section helpful?

•

mutation

After creating the UrlRedirectImport object, the UrlRedirectImport request can be performed using the urlRedirectImportSubmit mutation.

Anchor to urlurl • URL!required: The staged upload URL of the CSV file. You can download a sample URL redirect CSV file.

Anchor to urlRedirectImporturlRedirectImport • UrlRedirectImport: The created URLRedirectImport object.
Anchor to userErrorsuserErrors • [UrlRedirectImportUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Was this section helpful?