2.0info: 0.16.0 WMS-X Shipment General description: Serviço Foundation da expedição do WMS-X x-senior-domain: Expedição WMS-X x-senior-domain-path: wmsx_shipment x-senior-service-path: general contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /wmsx_shipment/generalsecurityDefinitions: 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: /apis/linkShipmentConfigurationWarehouse: post: description: The create request primitive for the linkShipmentConfigurationWarehouse facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/linkShipmentConfigurationWarehouseFacade responses: 200: description: Ok schema: #/definitions/linkShipmentConfigurationWarehouseFacade default: description: Error response schema: #/definitions/genericError /apis/linkOutBoundPickup: post: description: The create request primitive for the linkOutBoundPickup facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/linkOutBoundPickupFacade responses: 200: description: Ok schema: #/definitions/linkOutBoundPickupFacade default: description: Error response schema: #/definitions/genericError /apis/importOutBoundAuthorization: post: description: The create request primitive for the importOutBoundAuthorization facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/importOutBoundAuthorizationFacade responses: 200: description: Ok schema: #/definitions/importOutBoundAuthorizationFacade default: description: Error response schema: #/definitions/genericError /apis/linkShipmentConfigurationOwner: post: description: The create request primitive for the linkShipmentConfigurationOwner facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/linkShipmentConfigurationOwnerFacade responses: 200: description: Ok schema: #/definitions/linkShipmentConfigurationOwnerFacade default: description: Error response schema: #/definitions/genericError /apis/integrateOutBound: post: description: API DEPRECIADA | The create request primitive for the integrateOutBound facade. deprecated: true tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/integrateOutBoundFacade responses: 200: description: Ok schema: #/definitions/integrateOutBoundFacade default: description: Error response schema: #/definitions/genericError /apis/importOutBoundDocument: post: description: The create request primitive for the importOutBoundDocument facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/importOutBoundDocumentFacade responses: 200: description: Ok schema: #/definitions/importOutBoundDocumentFacade default: description: Error response schema: #/definitions/genericErrordefinitions: enumOutBoundDocumentType: type: string enum: – ORDER – INVOICE enumProductSituation: type: string enum: – GOOD – DAMAGED – EXPIRED – TRUNCATED enumOutboundReferenceKey: type: string enum: – INVOICE_DATE – INVOICE_NUMBER – INVOICE_SERIES – INVOICE_ACCESS_KEY linkOutBoundPickupFacade: type: object required: – pickupId properties: id: type: string description: format: uuid pickupId: type: string description: format: uuid outBoundIds: type: array items: type: string format: uuid description: removedIds: type: array items: type: string format: uuid description: importOutBoundDocumentFacade: type: object required: – documentNumber – consignee – documentType – productSituation properties: documentNumber: type: string description: Número de Pedido issuer: #/definitions/recShipmentPerson consignee: #/definitions/recShipmentPerson receiver: #/definitions/recShipmentTo carrierCode: type: string description: Código da Transportadora documentType: #/definitions/enumOutBoundDocumentType invoice: #/definitions/recInvoice shippingDate: type: string description: Data esperada do embarque format: date comments: type: string description: Observações do Pedido / Nota Fiscal warehouseCode: type: string description: Código do Armazém para integração, opcional se for único para o usuário ownerCode: type: string description: Código do Depositante para integração, opcional se for único para o usuário items: type: array items: #/definitions/recOutboundItem description: Items do Documento productSituation: #/definitions/enumProductSituation recShipmentPerson: type: object required: – code properties: code: type: string description: Código de Integração da Pessoa name: type: string description: Nome da Pessoa legalPerson: type: boolean description: Indica que é uma pessoa juridica national: type: boolean description: Indica se pessoa atua em mercado nacional documentNumber: type: string description: Documento – Ex: CNPJ / CPF / Passaporte recShipmentTo: type: object properties: code: type: string description: Código de Integração da Pessoa vinculada ao endereço entrega name: type: string description: Nome do Pessoa que recebe a entrega legalPerson: type: boolean description: Indica que é uma pessoa juridica national: type: boolean description: Indica se pessoa atua em mercado nacional documentNumber: type: string description: Documento – Ex: CNPJ / CPF / Passaporte shippingAddress: #/definitions/recAddress recAddress: type: object required: – address properties: address: type: string description: Rua do Endereço address2: type: string description: Complemento number: type: string description: Número do Endereço postalCode: type: string description: Código Postal neighborhood: type: string description: Bairro city: type: string description: Cidade state: type: string description: Estado country: type: string description: Pais isBussinessAddress: type: boolean description: É endereço comercial recInvoice: type: object required: – issueDate – number properties: issueDate: type: string description: Data de Emissão do Outbound / Nota Fiscal format: date number: type: integer description: Número da Nota Somente se DocumentType for Invoice serie: type: integer description: Serie da Nota accessKey: type: string description: Chave da Nota Fiscal recOutboundItem: type: object required: – productCode – quantity properties: itemNumber: type: integer description: Número que identifica o item productCode: type: string description: Código do Produto productSituation: #/definitions/enumProductSituation quantity: type: number description: Quantidade format: double packagingBarCode: type: string description: Código da Embalagem uom: type: string description: Unidade de Medida importOutBoundAuthorizationFacade: type: object required: – documentNumber – issuerCode properties: documentNumber: type: string description: Número de Pedido issuerCode: type: string description: Código Integração do Emissor do Pedido de Expedição referenceFields: type: array items: #/definitions/recOutboundReferenceFields description: Valores dos Campos de Referência para Autorização do Pedido de Expedição recOutboundReferenceFields: type: object required: – key – value properties: key: #/definitions/enumOutboundReferenceKey value: type: string description: Valor para Campo integrateOutBoundFacade: type: object required: – warehouseId – ownerId – receiverId – documentType – documentNumber properties: warehouseId: type: string description: Código do Armazém ownerId: type: string description: Código Depositante carrierId: type: string description: Código da Transportadora senderId: type: string description: Código do Remetente / Pessoa. Se não informado usa a pessoa do depositante receiverId: type: string description: Código do Destinatário / Pessoa receiverAdress: #/definitions/recAddress documentType: #/definitions/enumOutBoundDocumentType documentNumber: type: string description: Número de Pedido invoiceNumber: type: integer description: Número da Nota Somente se DocumentType for Invoice invoiceSeries: type: integer description: Serie da Nota issueDate: type: string description: Data de Emissão do Outbound / Nota Fiscal format: date invoiceAccessKey: type: string description: Chave da Nota Fiscal shippingDate: type: string description: Data esperada do embarque format: date comments: type: string description: Observações do Pedido / Nota Fiscal outboundItems: type: array items: #/definitions/recOutboundItem description: Lista correspondente aos produtos do pedido linkShipmentConfigurationOwnerFacade: type: object required: – shipmentConfigurationId properties: id: type: string description: format: uuid shipmentConfigurationId: type: string description: format: uuid ownerIds: type: array items: type: string format: uuid description: removedIds: type: array items: type: string format: uuid description: linkShipmentConfigurationWarehouseFacade: type: object required: – shipmentConfigurationId properties: id: type: string description: format: uuid shipmentConfigurationId: type: string description: format: uuid warehouseIds: type: array items: type: string format: uuid description: removedIds: type: array items: type: string format: uuid description: 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