CreateNomenclatureExportTask

POST 
/orgs/:org_guid/async/exports/nomenclature:new.xlsx

CreateNomenclatureExportTask

Request

Path Parameters

org_guid uuidrequired

Header Parameters

X-LP-Client-Identifier stringrequired
ClientIdentifier
Example: e004eeb3-a87b-4281-a646-8a824711b880
X-LP-Client-Type stringrequired
Possible values: [Unknown, App, WebApp, Service]
ClientType
Example: App
X-LP-Client-Name string
ClientName
Example: Swagger
X-LP-Client-OS-Name string
ClientOSName
Example: SwaggerDoc
X-LP-Client-OS-Version string
ClientOSVersion
Example: 1.0
X-LP-Client-Screen-Resolution string
ClientScreenResolution
Example: 1280x0900
X-LP-Client-Model string
ClientModel
Example: Chrome 75
X-LP-Organization-Alias string

OrganizationAlias

X-LP-Client-Extensions csv

ClientExtensions

Accept-Language stringrequired
Language
Example: en-US

application/json-patch+json

Body

attributes_for_export

object

include_uom_name_column boolean

include_uom_name_column

include_uom_symbol_column boolean

include_uom_symbol_column

include_uom_is_fractional_column boolean

include_uom_is_fractional_column

include_uom_ru_okei_column boolean

include_uom_ru_okei_column

include_uom_unece_column boolean

include_uom_unece_column

include_good_name_column boolean

include_good_name_column

include_good_tax_column boolean

include_good_tax_column

include_good_settlement_subject_column boolean

include_good_settlement_subject_column

include_good_default_price_column boolean

include_good_default_price_column

include_good_description_column boolean

include_good_description_column

include_good_made_in_column boolean

include_good_made_in_column

include_good_barcodes_ean13_column boolean

include_good_barcodes_ean13_column

include_good_barcodes_local_column boolean

include_good_barcodes_local_column

include_good_is_serial_column boolean

include_good_is_serial_column

include_good_markable_as_column boolean

include_good_markable_as_column

include_good_is_archived_column boolean

include_good_is_archived_column

include_good_is_part_of_column boolean

include_good_is_part_of_column

include_goods_category_column boolean

include_goods_category_column

selection_parameters SelectionModes (string)

Possible values: [alive_only, archived_only, all]

application/json

Body

attributes_for_export

object

include_uom_name_column boolean

include_uom_name_column

include_uom_symbol_column boolean

include_uom_symbol_column

include_uom_is_fractional_column boolean

include_uom_is_fractional_column

include_uom_ru_okei_column boolean

include_uom_ru_okei_column

include_uom_unece_column boolean

include_uom_unece_column

include_good_name_column boolean

include_good_name_column

include_good_tax_column boolean

include_good_tax_column

include_good_settlement_subject_column boolean

include_good_settlement_subject_column

include_good_default_price_column boolean

include_good_default_price_column

include_good_description_column boolean

include_good_description_column

include_good_made_in_column boolean

include_good_made_in_column

include_good_barcodes_ean13_column boolean

include_good_barcodes_ean13_column

include_good_barcodes_local_column boolean

include_good_barcodes_local_column

include_good_is_serial_column boolean

include_good_is_serial_column

include_good_markable_as_column boolean

include_good_markable_as_column

include_good_is_archived_column boolean

include_good_is_archived_column

include_good_is_part_of_column boolean

include_good_is_part_of_column

include_goods_category_column boolean

include_goods_category_column

selection_parameters SelectionModes (string)

Possible values: [alive_only, archived_only, all]

text/json

Body

attributes_for_export

object

include_uom_name_column boolean

include_uom_name_column

include_uom_symbol_column boolean

include_uom_symbol_column

include_uom_is_fractional_column boolean

include_uom_is_fractional_column

include_uom_ru_okei_column boolean

include_uom_ru_okei_column

include_uom_unece_column boolean

include_uom_unece_column

include_good_name_column boolean

include_good_name_column

include_good_tax_column boolean

include_good_tax_column

include_good_settlement_subject_column boolean

include_good_settlement_subject_column

include_good_default_price_column boolean

include_good_default_price_column

include_good_description_column boolean

include_good_description_column

include_good_made_in_column boolean

include_good_made_in_column

include_good_barcodes_ean13_column boolean

include_good_barcodes_ean13_column

include_good_barcodes_local_column boolean

include_good_barcodes_local_column

include_good_is_serial_column boolean

include_good_is_serial_column

include_good_markable_as_column boolean

include_good_markable_as_column

include_good_is_archived_column boolean

include_good_is_archived_column

include_good_is_part_of_column boolean

include_good_is_part_of_column

include_goods_category_column boolean

include_goods_category_column

selection_parameters SelectionModes (string)

Possible values: [alive_only, archived_only, all]

application/*+json

Body

attributes_for_export

object

include_uom_name_column boolean

include_uom_name_column

include_uom_symbol_column boolean

include_uom_symbol_column

include_uom_is_fractional_column boolean

include_uom_is_fractional_column

include_uom_ru_okei_column boolean

include_uom_ru_okei_column

include_uom_unece_column boolean

include_uom_unece_column

include_good_name_column boolean

include_good_name_column

include_good_tax_column boolean

include_good_tax_column

include_good_settlement_subject_column boolean

include_good_settlement_subject_column

include_good_default_price_column boolean

include_good_default_price_column

include_good_description_column boolean

include_good_description_column

include_good_made_in_column boolean

include_good_made_in_column

include_good_barcodes_ean13_column boolean

include_good_barcodes_ean13_column

include_good_barcodes_local_column boolean

include_good_barcodes_local_column

include_good_is_serial_column boolean

include_good_is_serial_column

include_good_markable_as_column boolean

include_good_markable_as_column

include_good_is_archived_column boolean

include_good_is_archived_column

include_good_is_part_of_column boolean

include_good_is_part_of_column

include_goods_category_column boolean

include_goods_category_column

selection_parameters SelectionModes (string)

Possible values: [alive_only, archived_only, all]

Responses

200

Success

application/json

Schema

Schema

mime_type stringnullable

mime_type

parameters

object

attributes_for_export

object

include_uom_name_column boolean

include_uom_name_column

include_uom_symbol_column boolean

include_uom_symbol_column

include_uom_is_fractional_column boolean

include_uom_is_fractional_column

include_uom_ru_okei_column boolean

include_uom_ru_okei_column

include_uom_unece_column boolean

include_uom_unece_column

include_good_name_column boolean

include_good_name_column

include_good_tax_column boolean

include_good_tax_column

include_good_settlement_subject_column boolean

include_good_settlement_subject_column

include_good_default_price_column boolean

include_good_default_price_column

include_good_description_column boolean

include_good_description_column

include_good_made_in_column boolean

include_good_made_in_column

include_good_barcodes_ean13_column boolean

include_good_barcodes_ean13_column

include_good_barcodes_local_column boolean

include_good_barcodes_local_column

include_good_is_serial_column boolean

include_good_is_serial_column

include_good_markable_as_column boolean

include_good_markable_as_column

include_good_is_archived_column boolean

include_good_is_archived_column

include_good_is_part_of_column boolean

include_good_is_part_of_column

include_goods_category_column boolean

include_goods_category_column

selection_parameters SelectionModes (string)

Possible values: [alive_only, archived_only, all]

status AsyncTaskStatuses (string)

Possible values: [InQueue, InProgress, WaitingForFeedback, Completed, Canceled]

progress int32

progress

resolutions

object[]

nullable

resolutions

Array [

message stringnullable

message

type ResolutionTypes (string)

Possible values: [Information, Warning, Error]

]

organization

object

guid uuid

guid

type_of string

type_of

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string
guid uuid

guid

type_of string

type_of

Example (from schema)

{
  "mime_type": "string",
  "parameters": {
    "attributes_for_export": {
      "include_uom_name_column": true,
      "include_uom_symbol_column": true,
      "include_uom_is_fractional_column": true,
      "include_uom_ru_okei_column": true,
      "include_uom_unece_column": true,
      "include_good_name_column": true,
      "include_good_tax_column": true,
      "include_good_settlement_subject_column": true,
      "include_good_default_price_column": true,
      "include_good_description_column": true,
      "include_good_made_in_column": true,
      "include_good_barcodes_ean13_column": true,
      "include_good_barcodes_local_column": true,
      "include_good_is_serial_column": true,
      "include_good_markable_as_column": true,
      "include_good_is_archived_column": true,
      "include_good_is_part_of_column": true,
      "include_goods_category_column": true
    },
    "selection_parameters": "alive_only"
  },
  "status": "InQueue",
  "progress": 0,
  "resolutions": [
    {
      "message": "string",
      "type": "Information"
    }
  ],
  "organization": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "created_at": "2024-11-18T08:30:48.217Z",
  "updated_at": "2024-11-18T08:30:48.217Z",
  "deleted_at": "2024-11-18T08:30:48.217Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type_of": "string"
}

401

Unauthorized

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

403

Forbidden

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

404

Not Found

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

422

Client Error

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

429

Too Many Requests

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

500

Server Error

application/json

Schema

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

Example (from schema)

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Loading...