2.0info: 1.13.1 integration description: Integração com o ERPX – WMS<br><strong>ATENÇÃO:</strong> Este serviço está em fase de validação com o piloto e pode sofrer alterações. x-senior-domain: ERPX – WMS x-senior-domain-path: erpx_wms x-senior-service-path: integration contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx_wms/integrationsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /orderReceiptPendingConference: post: description: Evento que indica a pendência de conferência de uma ordem de recebimento<br><strong>ATENÇÃO:</strong> Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – externalId – branch – document – items properties: externalId: type: string description: ID da ordem de recebimento branch: #/definitions/branch document: #/definitions/document items: type: array items: #/definitions/item description: Itens responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /orderReceiptConferenceSuccess: post: description: Evento que indica a conclusão da conferência de uma ordem de recebimento.<br><strong>ATENÇÃO:</strong> Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticket – externalId properties: ticket: type: string description: Ticket retornado pela api de conferencia externalId: type: string description: ID da ordem de recebimento responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /orderReceiptConferenceError: post: description: Evento que indica erro na conferência de uma ordem de recebimento.<br><strong>ATENÇÃO:</strong> Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticket – externalId – errorMessage properties: ticket: type: string description: Ticket retornado pela api de conferencia externalId: type: string description: id da ordem de recebimento errorMessage: type: string description: Mensagem de erro responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /orderReceiptCanceled: post: description: Evento que indica o cancelamento da ordem de recebimento.<br><strong>ATENÇÃO:</strong> Esta evento está em fase de validação com o piloto e pode sofrer alterações. x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – externalId – documentId properties: externalId: type: string description: Id da ordem de recebimento documentId: type: string description: Id do documento responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /orderSeparationPendingConference: post: description: Evento que indica a pendência de conferência de uma ordem de separação x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – externalId – branch – document – items properties: externalId: type: string description: ID da ordem de separação branch: #/definitions/branch document: #/definitions/document items: type: array items: #/definitions/item description: Itens responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /orderSeparationConferenceSuccess: post: description: Evento que indica a conclusão da conferência de uma ordem de separação x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticket – externalId properties: ticket: type: string description: Ticket retornado pela api de conferencia externalId: type: string description: ID da ordem de separação responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /orderSeparationConferenceError: post: description: Evento que indica erro na conferência de uma ordem de separação x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticket – externalId – errorMessage properties: ticket: type: string description: Ticket retornado pela api de conferencia externalId: type: string description: Id da ordem de separação errorMessage: type: string description: Mensagem de erro responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /invoiceOrderSeparation: post: description: Evento que retorna nota fiscal autorizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – externalId – document properties: externalId: type: string description: Id da ordem de separação document: #/definitions/document responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/returnOrderReceiptConference: post: description: The create request primitive for the returnOrderReceiptConference facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/returnOrderReceiptConferenceFacadeInput responses: 200: description: Ok schema: #/definitions/returnOrderReceiptConferenceFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/returnOrderSeparationConference: post: description: The create request primitive for the returnOrderSeparationConference facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/returnOrderSeparationConferenceFacadeInput responses: 200: description: Ok schema: #/definitions/returnOrderSeparationConferenceFacadeOutput default: description: Error response schema: #/definitions/genericErrordefinitions: documentType: type: string enum: – INCOMING_INVOICE – PRODUCTION_ORDER – RETURN_ORDER – PICKING_ORDER – SALE_PICKING_ORDER condition: type: string enum: – GOOD – DAMAGED branch: type: object required: – documentNumber – name properties: documentNumber: type: string description: Número (CPF, CNPJ ou NIF) name: type: string description: Nome tradeName: type: string description: Nome fantasia stateRegistration: type: string description: Inscrição estadual zipCode: type: string description: CEP address: type: string description: Logradouro addressNumber: type: string description: Número do endereço addressComplement: type: string description: Complemento do endereço neighborhood: type: string description: Bairro city: type: string description: Cidade state: type: string description: UF document: type: object required: – type properties: type: #/definitions/documentType number: type: string description: Número documento dateDocument: type: string description: Data do documento format: date invoice: #/definitions/invoice productionOrder: #/definitions/productionOrder order: #/definitions/order invoice: type: object required: – accessKey – series – noteType properties: accessKey: type: string description: Chave de acesso series: type: string description: Série noteType: type: string description: Tipo (Compra, Devolucao, Importacao, Venda) supplier: #/definitions/supplier protocolNumber: type: string description: Número do protocolo de autorização do documento eletrônico authorizationDate: type: string description: Data e hora de autorização do documento eletrônico format: date-time supplier: type: object required: – code – name – tradeName properties: id: type: string description: Identificador do fornecedor code: type: string description: Codigo do fornecedor documentNumber: type: string description: Número (CPF, CNPJ ou NIF) name: type: string description: Nome tradeName: type: string description: Nome fantasia stateRegistration: type: string description: Inscrição estadual productionOrder: type: object required: – labelType properties: labelType: type: string description: Tipo de etiqueta (Refugo, SubProduto, Produto, etc) resource: #/definitions/resource resource: type: object required: – code – description properties: code: type: string description: Código de identificação do recurso description: type: string description: Descrição do recurso order: type: object properties: id: type: string description: Identificador do pedido number: type: integer description: Número Pedido customer: #/definitions/customer customer: type: object properties: code: type: integer description: Código do cliente tradeName: type: string description: Nome fantasia name: type: string description: Nome do cliente address: type: string description: Endereço number: type: string description: Número do endereço complement: type: string description: Complemento postalCode: type: string description: Cep do endereço neighborhood: type: string description: Bairro city: type: string description: Cidade state: type: string description: Estado country: type: string description: País item: type: object required: – externalItemId – product – warehouse – unitOfMeasure – expectedQuantity properties: externalItemId: type: string description: ID da integração product: #/definitions/product warehouse: #/definitions/warehouse cfop: #/definitions/cfop unitOfMeasure: #/definitions/unitOfMeasure expectedQuantity: type: string description: Quantidade esperada unitPrice: type: string description: Preço unitário barcode: type: string description: Código de barras freeBarcode: type: string description: Código de barras livre gtin: type: string description: GTIN do produto batches: type: array items: #/definitions/batch description: Lotes series: type: array items: #/definitions/series description: Séries product: type: object required: – code – description properties: id: type: string description: Identificador do produto code: type: string description: Código do produto description: type: string description: Descrição do produto warehouse: type: object required: – code – description properties: code: type: string description: Código do depósito description: type: string description: Descrição do depósito cfop: type: object required: – code – description properties: code: type: string description: Código do CFOP description: type: string description: Descrição do CFOP unitOfMeasure: type: object required: – code – description properties: code: type: string description: Código description: type: string description: Descrição batch: type: object required: – code – quantity properties: code: type: string description: Código quantity: type: string description: Quantidade manufactureDate: type: string description: Data de fabricação format: date expirationDate: type: string description: Data de validade format: date series: type: object required: – code properties: code: type: string description: Código manufactureDate: type: string description: Data de fabricação format: date expirationDate: type: string description: Data de validade format: date returnOrderReceiptConferenceFacadeInput: type: object required: – externalId – document – items properties: externalId: type: string description: ID da ordem de recebimento document: #/definitions/document orderNumber: type: string description: Número da ordem de recebimento items: type: array items: #/definitions/itemOrder description: Itens conferidos na ordem itemOrder: type: object required: – externalItemId properties: externalItemId: type: string description: Identificador externo product: #/definitions/product warehouse: #/definitions/warehouse quantities: type: array items: #/definitions/quantity description: Quantidades quantity: type: object required: – condition – quantity properties: condition: #/definitions/condition quantity: type: string description: Quantidade recebida observation: type: string description: Observação batches: type: array items: #/definitions/batch description: Lotes recebidos series: type: array items: #/definitions/series description: Séries recebidas returnOrderReceiptConferenceFacadeOutput: type: object required: – ticket properties: ticket: type: string description: Ticket para recebimento do retorno via evento returnOrderSeparationConferenceFacadeInput: type: object required: – externalId – document – items properties: externalId: type: string description: ID da ordem de separação document: #/definitions/document items: type: array items: #/definitions/itemOrder description: Itens conferidos na ordem de separação returnOrderSeparationConferenceFacadeOutput: type: object required: – ticket properties: ticket: type: string description: Ticket para separação do retorno via evento genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE