Bayer Sellout Management (2.0.0)

Download OpenAPI specification:Download

To access the endpoints, request your OAuth2 authentication credentials.

RawData

Input Raw Data

Add a new raw data to the system.

Request Body schema: application/json

senderUuid required	string <uuid> Sender identifier in sellout base
required	object (Dealer)
required	Array of objects (Invoices) [ 1 .. 50 ] items

Responses

Request samples

Payload

Content type

application/json

{"senderUuid": "58931a85-4d4c-44fa-aa75-0d5d897ce38e",
"dealer": {"name": "Dealer MEX 43669",
"phoneNumber": "011999999999",
"email": "dealerMEX43669@email.com",
"internalCode": "001",
"sourceCode": "CODE-2020",
"sourceGroup": "GROUP-23021",
"salesRepresentativeName": "ANY NAME",
"salesRepresentativeERPCode": "ANY ERPCode",
"headquarter": true,
"erpCode": "CODE-123212",
"mainDocument": {"type": "DNI",
"number": "12312512312"
},
"document": [{"type": "DNI",
"number": "97348834395"
}
],
"address": {"address": "Calle de Pruebas Dealer 43669",
"number": "202",
"auxiliar": "",
"postalCode": "104559",
"city": "Guadalajara",
"state": "Jalisco",
"country": "MEX"
}
},
"invoices": [{"number": "2222",
"series": "005",
"date": "2021-11-18",
"sellerCode": "001",
"currency": "MXN",
"status": 1,
"paymentTerm": "bank_transfer",
"type": "1",
"operation": {"type": 1,
"code": "750001"
},
"observation": "",
"customer": {"name": "EmpresaTesteCO MEX 442797805",
"phoneNumber": "0118888888888",
"email": "customerpjMEX442797805@email.com",
"document": [{"type": "CNPJ",
"number": "ABB01010112A"
}
],
"address": {"address": "Calle de Pruebas Customer 442797805",
"number": "127",
"auxiliar": "",
"postalCode": "104861",
"city": "Guadalajara",
"state": "Jalisco",
"country": "MEX"
}
},
"items": [{"quantity": 3910,
"amount": 631,
"batch": "",
"status": 1,
"measureUnit": "KG",
"productCode": "000000000086285444",
"unitPrice": 199.9,
"discount": 0.05,
"exchange": {"currency": "USD",
"rate": 0.1
},
"productInfo": {"code": "UAX012",
"package": "XP",
"description": "Producto con descripción",
"category": "cajero"
},
"extraFields": {"measureUnitCode": "KG",
"originalMeasureUnitCode": "G",
"bayerMeasureUnit": "KG"
}
}
]
}
]
}

Response samples

200

Content type

application/json

{"senderUuid": "58931a85-4d4c-44fa-aa75-0d5d897ce38e",
"dealer": {"name": "Dealer MEX 43669",
"phoneNumber": "011999999999",
"email": "dealerMEX43669@email.com",
"internalCode": "001",
"sourceCode": "CODE-2020",
"sourceGroup": "GROUP-23021",
"salesRepresentativeName": "ANY NAME",
"salesRepresentativeERPCode": "ANY ERPCode",
"headquarter": true,
"erpCode": "CODE-123212",
"mainDocument": {"type": "DNI",
"number": "12312512312"
},
"document": [{"type": "DNI",
"number": "97348834395"
}
],
"address": {"address": "Calle de Pruebas Dealer 43669",
"number": "202",
"auxiliar": "",
"postalCode": "104559",
"city": "Guadalajara",
"state": "Jalisco",
"country": "MEX",
"uuid": "8d77a811-d3f1-479a-bbfa-1a4560c87c28"
},
"uuid": "9dfdd178-2e2b-459c-8b26-0597af507993"
},
"invoices": [{"number": "2222",
"series": "005",
"date": "2021-11-18",
"sellerCode": "001",
"currency": "MXN",
"status": 1,
"paymentTerm": "bank_transfer",
"type": "1",
"operation": {"type": 1,
"code": "750001"
},
"observation": "",
"customer": {"name": "EmpresaTesteCO MEX 442797805",
"phoneNumber": "0118888888888",
"email": "customerpjMEX442797805@email.com",
"document": [{"type": "CNPJ",
"number": "ABB01010112A"
}
],
"address": {"address": "Calle de Pruebas Customer 442797805",
"number": "127",
"auxiliar": "",
"postalCode": "104861",
"city": "Guadalajara",
"state": "Jalisco",
"country": "MEX",
"uuid": "0e74a78c-7db8-417f-89aa-3144b17f1ce1"
},
"uuid": "77b3aff4-6732-4059-8525-9e6c4a7ee646"
},
"items": [{"quantity": 3910,
"amount": 631,
"batch": "",
"status": 1,
"measureUnit": "KG",
"productCode": "000000000086285444",
"unitPrice": 199.9,
"discount": 0.05,
"exchange": {"currency": "USD",
"rate": 0.1
},
"productInfo": {"code": "UAX012",
"package": "XP",
"description": "Producto con descripción",
"category": "cajero"
},
"extraFields": {"measureUnitCode": "KG",
"originalMeasureUnitCode": "G",
"bayerMeasureUnit": "KG"
},
"uuid": "7be8741b-df2b-49a6-9fcf-585e9890f10e"
}
],
"uuid": "77b3aff4-6732-4059-8525-9e6c4a7ee646"
}
],
"sender": {"createdAt": "2023-11-30T12:00:00Z",
"updatedAt": "2023-11-30T13:30:00Z",
"deletedAt": null,
"id": 123,
"uuid": "c7794b7b-695d-48e0-93de-2926e0f2eaab",
"name": "sender name",
"phone": "+55123456789",
"email": "sender@example.com",
"documentId": 456,
"addressUuid": "def456",
"dataQualityStatus": "approved"
},
"notes": "This is a sample note.",
"traceId": "d7d7b772-3f67-4fad-b889-cafb57a51313"
}

Raw data status

Returns the raw data status by date or traceId.

Request Body schema: application/json

senderUuid required	string Sender identifier in sellout base
initialDate	string For a raw data search after a date, use the format (YYYY-MM-DD)
endDate	string For a raw data search before a date, use the format (YYYY-MM-DD)
traceId	string Search by the Trace ID from raw data

Responses

Request samples

Payload

Content type

application/json

Example

Between

{"senderUuid": "58931a85-4d4c-44fa-aa75-0d5d897ce38e",
"initialDate": "2022-02-20",
"endDate": "2022-03-22"
}

Response samples

200
400
401
500

Content type

application/json

{"statusCode": 0,
"body": [{"id": 0,
"sender": {"name": "string",
"uuid": "string",
"status": "string",
"address": {"status": "string"
},
"document": {"status": "string"
}
},
"dealer": {"status": "string",
"address": {"status": "string"
},
"document": {"status": "string"
}
},
"errors": [{"id": 0,
"ownerId": 0,
"ownerType": "string",
"field": "string",
"value": "string",
"error": "string",
"createdAt": "string"
}
],
"invoices": [{"id": 0,
"number": "string",
"date": "string",
"status": "string",
"customer": {"id": 0,
"name": "string",
"uuid": "string",
"status": "string",
"address": {"uuid": "string",
"street": "string",
"number": "string",
"status": "string"
},
"document": {"number": "string",
"type": "string",
"status": "string"
}
},
"items": [{"product": "string",
"status": "string",
"batch": "string",
"amount": "string",
"quantity": "string"
}
]
}
]
}
]
}

DataQualityError

Get dataquality errors

Get all dataquality errors by senderUuid.

Request Body schema: application/json

filterString	string Filter by some text
orderBy	string Order by a column
orderByDirection	string Choose a direction order , can be DESC or ASC
page required	number Choose the page to recover
perPage required	number Choose the number of items to return
date	string Date to filter
startDate	string Start date to filter
endDate	string End date to filter
senderUuid required	string Sender identifier in sellout base
ownerId	number Owner identifier in sellout base
ownerType	string Owner type in sellout base

Responses

Request samples

Payload

Content type

application/json

Example

Between

{"filterString": "",
"page": 1,
"perPage": 10,
"startDate": "2021-01-01",
"endDate": "2021-12-31",
"senderUuid": "58931a85-4d4c-44fa-aa75-0d5d897ce38e"
}

Response samples

200
400
422
500

Content type

application/json

{"statusCode": 200,
"body": {"total": 10,
"data": [{"createdAt": "2021-01-01T00:00:00.000Z",
"id": 1,
"ownerId": 10001,
"ownerType": "rawData",
"field": "rawItem[0].productCode",
"value": "000000000012383710",
"error": "not found",
"extra": {"invoices": {"invoice": {"invoiceDate": "2021-01-01T00:00:00.000z",
"invoiceNumber": "00004A00001752",
"invoiceUuid": "4390a028b0214bd6ba076fc08d3b1afe-94b5be5c51a440192522",
"invoiceItem": {"productCode": "000000000012383710",
"invoiceItemUuid": "4390a028b0214bd6ba076fc08d3b1afe-253fe425f33360948817"
}
}
}
}
}
]
}
}

Products

Get products

Get all products by senderUuid.

Request Body schema: application/json

filterString	string Filter by some text
isActive	boolean Filter by status
orderBy	string Order by a column
orderByDirection	string Choose a direction order , can be DESC or ASC
page required	number Choose the page to recover
perPage required	number Choose the number of items to return
senderUuid required	string Sender identifier in sellout base

Responses

Request samples

Payload

Content type

application/json

{"filterString": "",
"isActive": true,
"orderBy": "id",
"orderByDirection": "DESC",
"page": 1,
"perPage": 10,
"senderUuid": "58931a85-4d4c-44fa-aa75-0d5d897ce38e"
}

Response samples

200
400
401
500

Content type

application/json

{"statusCode": 0,
"body": {"total": 0,
"data": [{"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"id": 0,
"description": "string",
"manufacturerCode": "string",
"packedUnits": 0,
"countryId": 0,
"culture": "string",
"brand": "string",
"measureUnitId": 0,
"measureUnit": {"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"id": 0,
"name": "string"
},
"country": {"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"id": 0,
"code": "string",
"subCode": "string",
"culture": "string",
"profile": "string"
}
}
]
}
}

DocumentTypes

Get document types

Get all document types by profileToken or senderUuid.

Request Body schema: application/json

id	number Get document type by id
filterString	string Filter by some text
isActive	boolean Filter by status
orderBy	string Order by a column
orderByDirection	string Choose a direction order , can be DESC or ASC
page required	number Choose the page to recover
perPage required	number Choose the number of items to return
senderUuid required	string Sender identifier in sellout base

Responses

Request samples

Payload

Content type

application/json

Example

With-Id

{"id": 1,
"filterString": "",
"isActive": true,
"orderBy": "id",
"orderByDirection": "DESC",
"page": 1,
"perPage": 10,
"senderUuid": "58931a85-4d4c-44fa-aa75-0d5d897ce38e"
}

Response samples

200
400
401
500

Content type

application/json

{"statusCode": 0,
"body": {"total": 0,
"data": [{"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"id": 0,
"name": "string"
}
]
}
}

MeasureUnits

Get measure units

Get all measure units.

Request Body schema: application/json

filterString	string Filter by some text
isActive	boolean Filter by status
orderBy	string Order by a column
orderByDirection	string Choose a direction order , can be DESC or ASC
page	number Choose the page to recover
perPage	number Choose the number of items to return
senderUuid required	string Sender identifier in sellout base

Responses

Request samples

Payload

Content type

application/json

{"filterString": "",
"isActive": true,
"orderBy": "id",
"orderByDirection": "DESC",
"page": 1,
"perPage": 10,
"senderUuid": "58931a85-4d4c-44fa-aa75-0d5d897ce38e"
}

Response samples

200
400
401
500

Content type

application/json

{"statusCode": 0,
"body": {"total": 0,
"data": [{"createdAt": "string",
"updatedAt": "string",
"deletedAt": "string",
"id": 0,
"name": "string"
}
]
}
}

Output

GraphQL

PREENCHER

Request Body schema: application/json
required

asdasd

query

required

string

Responses

Request samples

Payload

Content type

application/json

{"query": "{\n  invoices(\n    pagination: { page: 1, perPage: 100 }\n    created: { from: \"2010-01-01\", to: \"2026-01-01\" }\n    date: { from: \"2010-01-01\", to: \"2026-01-01\" }\n    countryCode: \"MX\"\n    skipTermsAndConditions: true\n  ) {\n    TotalItems\n    SellOutDetails {\n      id\n      sentAt\n      uuid\n      code\n      series\n      paymentTerm\n      observation\n      sellerCode\n      rawDataId\n      dataQualityStatus\n      invoiceNumber\n      invoiceDate\n      status\n      operationTypeId\n      sender {\n        id\n        name\n        uuid\n        phone\n        email\n        address {\n          id\n          uuid\n          street\n          number\n          postalCode\n          city\n          state\n          country {\n            code\n            subCode\n            culture\n            profile\n          }\n        }\n        document {\n          number\n          type {\n            name\n          }\n        }\n      }\n      dealer {\n        name\n        uuid\n        phone\n        email\n        internalCode\n        address {\n          uuid\n          street\n          number\n          postalCode\n          city\n          state\n          country {\n            code\n            subCode\n            culture\n            profile\n          }\n        }\n        document {\n          number\n          type {\n            name\n          }\n        }\n      }\n      soldTo {\n        name\n        document {\n          number\n          type {\n            name\n          }\n        }\n        address {\n          uuid\n          street\n          number\n          postalCode\n          city\n          state\n          country {\n            code\n            subCode\n            culture\n            profile\n          }\n        }\n      }\n      currency {\n        code\n      }\n      invoiceItems {\n        uuid\n        id\n        quantity\n        unitPrice\n        discount\n        amount\n        extraFields {\n          key\n          value\n        }\n        productInfo {\n          code\n          package\n          description\n          category\n        }\n        exchange {\n          currency\n          rate\n        }\n        product {\n          id\n          manufacturerCode\n          country {\n            code\n          }\n          description\n          packedUnits\n          culture\n          measureUnit {\n            id\n            name\n          }\n        }\n        measureUnit {\n          id\n          name\n        }\n      }\n    }\n  }\n}\n"
}

Response samples

200
400
401
500

Content type

application/json

{"statusCode": 0,
"data": {"invoices": {"TotalItems": 0,
"SellOutDetails": [{"id": 0,
"sentAt": "string",
"uuid": "string",
"code": "string",
"series": "string",
"paymentTerm": "string",
"observation": "string",
"sellerCode": "string",
"rawDataId": 0,
"dataQualityStatus": "string",
"invoiceNumber": "string",
"invoiceDate": "string",
"status": true,
"operationTypeId": 0,
"sender": {"id": 0,
"name": "string",
"uuid": "string",
"phone": "string",
"email": "string",
"address": {"id": 0,
"uuid": "string",
"street": "string",
"number": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"country": {"code": "string",
"subCode": "string",
"culture": "string",
"profile": "string"
}
},
"document": {"number": "string",
"type": {"name": "string"
}
}
},
"dealer": {"name": "string",
"uuid": "string",
"phone": "string",
"email": "string",
"internalCode": "string",
"address": {"uuid": "string",
"street": "string",
"number": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"country": {"code": "string",
"subCode": "string",
"culture": "string",
"profile": "string"
}
},
"document": {"number": "string",
"type": "string"
}
},
"soldTo": {"name": "string",
"document": {"number": "string",
"type": {"name": "string"
}
},
"address": {"uuid": "string",
"street": "string",
"number": "string",
"postalCode": "string",
"city": "string",
"state": "string",
"country": {"code": "string",
"subCode": "string",
"culture": "string",
"profile": "string"
}
}
},
"currency": {"code": "string"
},
"invoiceItems": [{"uuid": "string",
"id": 0,
"quantity": 0,
"unitPrice": 0,
"discount": 0,
"amount": 0,
"extraFields": [{"key": "string",
"value": "string"
}
],
"productInfo": {"code": "string",
"package": "string",
"description": "string",
"category": "string"
},
"exchange": {"currency": "string",
"rate": 0
},
"product": {"id": 0,
"manufacturerCode": "string",
"description": "string",
"packedUnits": "string",
"culture": "string",
"measureUnit": {"id": 0,
"name": "string"
}
},
"measureUnit": {"id": 0,
"name": "string"
}
}
]
}
]
}
}
}

Bayer Sellout Management (2.0.0)

RawData

Input Raw Data

Request Body schema: application/json

Responses

Request samples

Response samples

Raw data status

Request Body schema: application/json

Responses

Request samples

Response samples

DataQualityError

Get dataquality errors

Request Body schema: application/json

Responses

Request samples

Response samples

Products

Get products

Request Body schema: application/json

Responses

Request samples

Response samples

DocumentTypes

Get document types

Request Body schema: application/json

Responses

Request samples

Response samples

MeasureUnits

Get measure units

Request Body schema: application/json

Responses

Request samples

Response samples

Output

GraphQL

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required