Back to top

API Documentation

Products

Products

URLBASE: https://n8pu9xx2ba.execute-api.us-east-1.amazonaws.com/products-massive

Create product
POST/{?culture}

A product is created by associating an EAN with all the relevant content for the client, including name, description, specifications, etc. If your product has “Variations” which means if it has different sizes and colors for the same reference then each variation must be sent with their own EAN but must be associated to a parent variation through the field Reference. The product acts as a container and allows offers to be associated for the product to be shown in the sites.

Notes

  1. All fields are mandatory except for the Features. Note that Technology products don’t require a parent reference nor variation fields, while Clothing products do.

  2. The is a request limit of 400 individual EAN

  3. If an EAN is sent with a parent reference that already exists then it will be associated as a variation of said parent reference

  4. All products will require approval by Exito’s content team, the seller will receive either approval or rejection of each product to their registered email

  5. If a registry is sent without the EAN field then a generic EAN will be associated and communicated once the product has been approved

  6. Please check the manual for all field validations https://s3.amazonaws.com/sellercenter.api.exito.com/products_guide.pdf

Example URI

POST /?culture=es-CO
URI Parameters
HideShow
culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

Request  Products Technology
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Body
[
  {
    "Ean": "9205147694107",
    "Name": "Camara deportiva",
    "Category": "27193",
    "Brand": "ADIDAS",
    "Description": "<p>La mejor camara del mundo</p>",
    "KeyWords": "camara,deportes,adidas,tecnologia",
    "PackageHeight": "11",
    "PackageLength": "21",
    "PackageWidth": "34",
    "PackageWeight": "1",
    "SkuShippingSize": "1",
    "ProductHeight": "1",
    "ProductLength": "1",
    "ProductWidth": "1",
    "ProductWeight": "1",
    "Seller": "Marketplace",
    "ProductType": "Technology",
    "ImageUrl1": "https://i.postimg.cc/Y962X3D5/71-SBv-Gp-COML-AC-SL1420-1.jpg",
    "ImageUrl2": "http://glshub.omni.pro/imagenes/N742517-451-M_2.jpg",
    "ImageUrl3": null,
    "ImageUrl4": null,
    "ImageUrl5": null,
    "ModifyImage": null,
    "IsLogisticsExito": "0",
    "MeasurementUnit": "Unidad",
    "ConversionFactor": "1",
    "DrainedFactor": null,
    "EanCombo": null,
    "features": [
      {
        "key": "Tipo de cámara",
        "value": "Deportiva"
      }
    ],
    "SellerSku": "1992"
  }
]
Request  Products Clothing
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Body
[
  {
    "Ean": "9205147694107",
    "Name": "Blusa Polo Deportiva",
    "Category": "50031",
    "Brand": "POLO",
    "Description": "Lo mejor para ejercitarse",
    "KeyWords": "blusa,deporte,fit,polo",
    "PackageHeight": "1",
    "PackageLength": "1",
    "PackageWidth": "1",
    "PackageWeight": "1",
    "SkuShippingSize": "1",
    "ProductHeight": "1",
    "ProductLength": "1",
    "ProductWidth": "1",
    "ProductWeight": "1",
    "Seller": "Marketplace",
    "ProductType": "Clothing",
    "ImageUrl1": "https://vicsaconectados.vteximg.com.br/arquivos/ids/159410-1000-1000/COOLDRY-MUJER-MANGA-CORTA-ROJO-FRENTE-1000X1000.jpg",
    "ImageUrl2": null,
    "ImageUrl3": null,
    "ImageUrl4": null,
    "ImageUrl5": null,
    "ModifyImage": null,
    "IsLogisticsExito": "0",
    "MeasurementUnit": "Unidad",
    "ConversionFactor": "1",
    "DrainedFactor": null,
    "EanCombo": null,
    "features": [],
    "ParentReference": "BlusaPolo",
    "SonReference": "9205147694107",
    "Size": "S",
    "Color": "Rojo",
    "HexColourName": "Rojo_Oscuro",
    "SellerSku": "1993"
  },
  {
    "Ean": "0",
    "Name": "Blusa Polo Deportiva",
    "Category": "50031",
    "Brand": "POLO",
    "Description": "Lo mejor para ejercitarse",
    "KeyWords": "blusa,deporte,fit,polo",
    "PackageHeight": "1",
    "PackageLength": "1",
    "PackageWidth": "1",
    "PackageWeight": "1",
    "SkuShippingSize": "1",
    "ProductHeight": "1",
    "ProductLength": "1",
    "ProductWidth": "1",
    "ProductWeight": "1",
    "Seller": "Marketplace",
    "ProductType": "Clothing",
    "ImageUrl1": "https://vicsa.vteximg.com.br/arquivos/ids/168378-1000-1000/COOLDRY-MUJER-MANGA-CORTA-AZUL-FRENTE-1000X1000.jpg",
    "ImageUrl2": null,
    "ImageUrl3": null,
    "ImageUrl4": null,
    "ImageUrl5": null,
    "ModifyImage": null,
    "IsLogisticsExito": "0",
    "MeasurementUnit": "Unidad",
    "ConversionFactor": "1",
    "DrainedFactor": null,
    "EanCombo": null,
    "features": [],
    "ParentReference": "BlusaPolo",
    "SonReference": null,
    "Size": "S",
    "Color": "Azul",
    "HexColourName": "Azul",
    "SellerSku": "1994"
  },
  {
    "Ean": "0",
    "Name": "Blusa Polo Deportiva",
    "Category": "50031",
    "Brand": "POLO",
    "Description": "Lo mejor para ejercitarse",
    "KeyWords": "blusa,deporte,fit,polo",
    "PackageHeight": "1",
    "PackageLength": "1",
    "PackageWidth": "1",
    "PackageWeight": "1",
    "SkuShippingSize": "1",
    "ProductHeight": "1",
    "ProductLength": "1",
    "ProductWidth": "1",
    "ProductWeight": "1",
    "Seller": "Marketplace",
    "ProductType": "Clothing",
    "ImageUrl1": "https://vicsaconectados.vteximg.com.br/arquivos/ids/159408-1000-1000/COOLDRY-MUJER-MANGA-CORTA-BLANCO-FRENTE-1000X1000.jpg",
    "ImageUrl2": null,
    "ImageUrl3": null,
    "ImageUrl4": null,
    "ImageUrl5": null,
    "ModifyImage": null,
    "IsLogisticsExito": "0",
    "MeasurementUnit": "Unidad",
    "ConversionFactor": "1",
    "DrainedFactor": null,
    "EanCombo": null,
    "features": [],
    "ParentReference": "BlusaPolo",
    "SonReference": null,
    "Size": "S",
    "Color": "Blanco",
    "HexColourName": "Blanco",
    "SellerSku": "1995"
  }
]
Request  Combo Products
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Body
[
  {
    "Ean": "9205147694108",
    "Name": "Computador Gamer y Mouse Gamer",
    "Category": "27193",
    "Brand": "ADIDAS",
    "Description": "<p>El mejor combo del mundo</p>",
    "KeyWords": "camara,deportes,adidas,tecnologia",
    "PackageHeight": "11",
    "PackageLength": "21",
    "PackageWidth": "34",
    "PackageWeight": "1",
    "SkuShippingSize": "1",
    "ProductHeight": "1",
    "ProductLength": "1",
    "ProductWidth": "1",
    "ProductWeight": "1",
    "Seller": "Marketplace",
    "ProductType": "Technology",
    "ImageUrl1": "https://i.postimg.cc/Y962X3D5/71-SBv-Gp-COML-AC-SL1420-1.jpg",
    "ImageUrl2": "http://glshub.omni.pro/imagenes/N742517-451-M_2.jpg",
    "ImageUrl3": null,
    "ImageUrl4": null,
    "ImageUrl5": null,
    "ModifyImage": null,
    "IsLogisticsExito": "0",
    "MeasurementUnit": "Unidad",
    "ConversionFactor": "1",
    "DrainedFactor": null,
    "EanCombo": "9205147694105,9205147694104",
    "features": [
      {
        "key": "Tipo de cámara",
        "value": "Deportiva"
      }
    ],
    "SellerSku": "1996"
  }
]
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "Errors": [],
  "Data": [
    {
      "totalProcess": 1,
      "error": 1,
      "successful": 0,
      "fileName": "",
      "productNotifyViewModel": [
        {
          "Ean": "981567483264154",
          "Message": "'Nombre del producto' no es válido."
        }
      ]
    }
  ],
  "Message": "Operación realizada éxitosamente."
}

Get Status

Get Status Bulk Upload
GET/status{?culture}

Notes

The allowed values ​​for the status property are:

  1. Processing = 1
  2. Completed Correctly = 2
  3. Finished with errors = 3
  4. Starting the product creation process = 4

When starting a product creation process, the initial state will be four 4, when the products of that request start to be processed, it will go to one 1 and depending on the result it will take the value of two 2 or three 3.

Values ​​one and four will indicate an active loading process, so it will not be possible to send new products until the status is two or three.

The data property describes the status of the process, and the response property contains in json format a specific detail of the result of the last process performed.

Example URI

GET /status?culture=es-CO
URI Parameters
HideShow
culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

Request
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [],
  "Message": "Operación realizada éxitosamente.",
  "data": {
    "idSeller": 100121,
    "status": 3,
    "checked": "false",
    "response": "{\"Data\":{\"TotalProcess\":0,\"Error\":14,\"Successful\":0,\"ProductNotify\":[{\"Ean\":\"FI1RM0037406412\",\"Message\":\"La marca no existe en la base de datos.\",\"ProductName\":\"Tenis Fila 1RM00374064 Hombre-Multicolor\"}]}}"
  }
}
Schema
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "description": "List of errors generated in request"
    },
    "Message": {
      "type": "string",
      "description": "Message result request"
    },
    "data": {
      "type": "object",
      "description": "Information of status bulk",
      "propierties": {
        "idSeller": {
          "type": "number",
          "description": "Identification of Seller"
        },
        "status": {
          "type": "number",
          "description": "Status Id"
        },
        "checked": {
          "type": "bool",
          "description": "Indicate"
        },
        "response": {
          "type": "string",
          "description": "Object serializate in json",
          "properties": {
            "Data": {
              "type": "object",
              "description": "Result of Bulk Upload.",
              "properties": {
                "TotalProcess": {
                  "type": "number",
                  "description": "Total of products processed"
                },
                "Error": {
                  "type": "number",
                  "description": "Total of errors in bulk"
                },
                "Successful": {
                  "type": "number",
                  "description": "Total of products without errors"
                },
                "ProductNotify": {
                  "type": "array",
                  "description": "Description of errors generated",
                  "items": {
                    "type": "object",
                    "description": "information of errors",
                    "properties": {
                      "Ean": {
                        "type": "string",
                        "description": "Ean with error"
                      },
                      "Message": {
                        "type": "string",
                        "description": "Description of error"
                      },
                      "ProductName": {
                        "type": "string",
                        "description": "Name of product with error"
                      }
                    }
                  },
                  "minItems": 0
                }
              }
            }
          }
        }
      }
    }
  }
}

Product

Notify Result Moderation
PATCH/notifyproduct

You have to develop a service patch, where we will notify the status when the products are validated.

When the product is validated by the ‘Grupo Exito Content Team’, the result of said validation will be notified on each product.

This notification will be only if in the creation of the product the information related to the SellerSku was sent.

This endpoint have to send to Exito for configurate it on your user.

Example URI

PATCH /notifyproduct
Request  Products Rejected
HideShow
Headers
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Body
[
  {
    "Ean": "IZ20000062863",
    "SellerSku": "1994",
    "Response": "Rechazado",
    "Comment": "Nombre no válido",
    "Reason": "Nombre no válido",
    "IsUpdating": false
  },
  {
    "Ean": "IZ20000062862",
    "SellerSku": "1992",
    "Response": "Rechazado",
    "Comment": "Nombre no válido",
    "Reason": "Nombre no válido",
    "IsUpdating": false
  }
]
Request  Products Approved
HideShow
Headers
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Body
[
  {
    "Ean": "IZ20000062863",
    "SellerSku": "1994",
    "Response": "Aprobado",
    "Comment": "",
    "Reason": "",
    "IsUpdating": false
  },
  {
    "Ean": "IZ20000062862",
    "SellerSku": "1992",
    "Response": "Aprobado",
    "Comment": "",
    "Reason": "",
    "IsUpdating": false
  }
]
Response  200

Features

GetFeaturesbyCategoryId

URLBASE: https://v4lygeaus7.execute-api.us-east-1.amazonaws.com/

Get Features by Category Id
GET/specs-external/getbycategoryid/{id}{?culture}

Consult the groups of specifications assigned to a Category.

Example URI

GET /specs-external/getbycategoryid/28086?culture=es-CO
URI Parameters
HideShow
id
number (required) Example: 28086

Category Id to check the specifications.

culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

Request
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [],
  "data": [
    {
      "idGroup": "",
      "groupName": "Shoes",
      "specs": [
        {
          "idSpec": "",
          "specName": "Type of Cane",
          "required": false,
          "values": [
            {
              "label": "Media",
              "displayName": "Media"
            },
            {
              "label": "Alta",
              "displayName": "High"
            },
            {
              "label": "Baja",
              "displayName": "Low"
            }
          ],
          "listValues": null,
          "label": "Tipo de Caña"
        },
        {
          "idSpec": "",
          "specName": "Material Principal",
          "required": false,
          "values": [],
          "listValues": null,
          "label": "Material Principal"
        }
      ],
      "id": null,
      "categories": "[\"28086\"]",
      "listCategories": [],
      "idVTEX": "",
      "label": "Calzado"
    }
  ],
  "message": "Operation successful"
}
Schema
{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "description": "List of errors generated in request"
    },
    "data": {
      "type": "array",
      "description": "List of group of specifications assigned to Category",
      "items": {
        "type": "object",
        "description": "group of specifications",
        "properties": {
          "idGroup": {
            "type": "string",
            "description": "Group Id."
          },
          "groupName": {
            "type": "string",
            "description": "Group Name."
          },
          "specs": {
            "type": "array",
            "description": "List of specifications assigned to Category",
            "items": {
              "type": "object",
              "description": "specification valid by Category",
              "properties": {
                "idSpec": {
                  "type": "string",
                  "description": "Spec Id."
                },
                "specName": {
                  "type": "string",
                  "description": "Spec Name."
                },
                "required": {
                  "type": "bool",
                  "description": "Indicates whether the specification is mandatory"
                },
                "values": {
                  "type": "array",
                  "description": "Lista de valores permitidos para la especificacion",
                  "items": {
                    "type": "object",
                    "description": "Estructura que representa los valores permitidos de la especificacion",
                    "properties": {
                      "label": {
                        "type": "string",
                        "description": "etiqueta de traducción empleada en el valor"
                      },
                      "displayName": {
                        "type": "string",
                        "description": "Valor permitido para la especificacion"
                      }
                    }
                  },
                  "minItems": 0
                },
                "listValues": {
                  "type": "string",
                  "description": "No usado"
                },
                "label": {
                  "type": "string",
                  "description": "Etiqueta de traducción empleada en la especificacion"
                }
              }
            },
            "minItems": 0
          },
          "id": {
            "type": "string",
            "description": "Id asignado al grupo"
          },
          "categories": {
            "type": "string",
            "description": "Id de Categorias a las cuales aplica el grupo de especificaciones"
          },
          "listCategories": {
            "type": "array",
            "description": "Id de Categorias a las cuales aplica el grupo de especificaciones",
            "items": {
              "type": "string"
            },
            "maxItems": 0
          },
          "idVTEX": {
            "type": "string",
            "description": "Id del grupo de especificaciones"
          },
          "label": {
            "type": "string",
            "description": "Etiqueta de traducción empleada en el grupo de especificaciones"
          }
        }
      },
      "minItems": 2
    },
    "message": {
      "type": "string",
      "description": "Mensaje de respuesta para indicar estado de la solicitud"
    }
  }
}

Offers

Offers

URLBASE: https://1izv6nqmub.execute-api.us-east-1.amazonaws.com

Create/Update offers
PATCH/OfferExternal{?culture}

An offer is associated to an EAN and contains all the unique information of the product for a Seller, including price and stock. A created or updated offer will be shown in the product for all available channels in which the Seller is active.

You can create and update offers in Grupo Exito’s different sites.

Notes

  1. The fields are mandatory in the creation of a new offer.

  2. The EAN, Stock and Price fields are mandatory when modifying an offer.

  3. If you want to change the inventory of an existing offer, the IsUpdatedStock field must have a value of 1.

  4. If you want to change the price of an offer and the change is more than 30% of the current price, you must send the attribute PriceApproval = 1

  5. The periodicity of the delivery promise can be expressed in business days or hours. For business days the value is Periodicity = 1 and for hours it is Periodicity = 2. If you do not send this value when creating the offer or modifying it, it will be established by default Business Days

  6. The SellerSku is the Id Product in your System. This field is optional.

  7. Please check the manual for all field validations https://s3.amazonaws.com/sellercenter.api.exito.com/offers_guide.pdf

Example URI

PATCH /OfferExternal?culture=es-CO
URI Parameters
HideShow
culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

Request  Individual Product Offer
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Body
{
  "PriceApproval": 0,
  "ListOffers": [
    {
      "EAN": "7701410118349",
      "Stock": "3",
      "Price": "16000.00",
      "DiscountPrice": "20000.00",
      "AverageFreightCost": "25000.00",
      "PromiseDelivery": "1 a 10",
      "Warranty": 50,
      "IsFreeShipping": 0,
      "IsEnviosExito": 0,
      "IsFreightCalculator": 0,
      "IsLogisticsExito": 0,
      "IsUpdatedStock": 1,
      "Currency": "COP",
      "Periodicity": 1,
      "SellerSku": "1992"
    },
    {
      "EAN": "7701410118035",
      "Stock": "3",
      "Price": "20000.00",
      "DiscountPrice": "11000.00",
      "AverageFreightCost": "50000.00",
      "PromiseDelivery": "1 a 10",
      "Warranty": 50,
      "IsFreeShipping": 0,
      "IsEnviosExito": 0,
      "IsFreightCalculator": 0,
      "IsLogisticsExito": 0,
      "IsUpdatedStock": 1,
      "Currency": "COP",
      "Periodicity": 1,
      "SellerSku": "1993"
    }
  ]
}
Request  Combo Product Offer
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Body
{
  "PriceApproval": 0,
  "ListOffers": [
    {
      "EAN": "2365477746910",
      "Stock": 1,
      "Price": "2100000.00",
      "DiscountPrice": "2000000",
      "AverageFreightCost": "2000.00",
      "PromiseDelivery": "1 a 2",
      "Warranty": 3,
      "IsFreeShipping": 0,
      "IsEnviosExito": 0,
      "IsFreightCalculator": 0,
      "IsLogisticsExito": "0",
      "IsUpdatedStock": 1,
      "Currency": "COP",
      "Periodicity": 1,
      "SellerSku": "1992"
    },
    {
      "EanCombo": "2365477746910",
      "Price": "500000",
      "ComboQuantity": "1",
      "EAN": "0321321321321"
    },
    {
      "EanCombo": "2365477746910",
      "Price": "1000000",
      "ComboQuantity": "1",
      "EAN": "ABC7573747057914"
    },
    {
      "EanCombo": "2365477746910",
      "Price": "500000",
      "ComboQuantity": "1",
      "EAN": "0334589034881"
    }
  ]
}
Request  Custom City
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Body
{
  "PriceApproval": 0,
  "ListOffers": [
    {
      "EAN": "7701410118349",
      "Stock": "3",
      "Price": "16000.00",
      "DiscountPrice": "20000.00",
      "AverageFreightCost": "25000.00",
      "PromiseDelivery": "1 a 10",
      "Warranty": 50,
      "IsFreeShipping": 0,
      "IsEnviosExito": 0,
      "IsFreightCalculator": 0,
      "IsLogisticsExito": 0,
      "IsUpdatedStock": 1,
      "Currency": "COP",
      "Periodicity": 1,
      "SellerSku": "1992",
      "DaneCode": "18001000",
      "Address": "Calle Oscura"
    }
  ]
}
Request  Update Offer
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Body
{
  "PriceApproval": 0,
  "ListOffers": [
    {
      "EAN": "7701410118349",
      "Stock": "3",
      "Price": "16000.00",
      "SellerSku": "1993"
    },
    {
      "EAN": "7701410118349",
      "Stock": "3",
      "Price": "16000.00",
      "DiscountPrice": "20000.00",
      "AverageFreightCost": "25000.00",
      "PromiseDelivery": "1 a 10",
      "Warranty": 50,
      "IsFreeShipping": 0,
      "IsEnviosExito": 0,
      "IsFreightCalculator": 0,
      "IsLogisticsExito": 0,
      "IsUpdatedStock": 1,
      "Currency": "COP",
      "Periodicity": 1,
      "SellerSku": "1992"
    }
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "Operation successful",
  "errors": [],
  "data": {
    "totalProcess": 1,
    "error": 1,
    "successful": 0,
    "offerNotifyViewModels": [
      {
        "ean": "7701410118349",
        "message": "There are '7701410118349' EAN that suffer an extreme change in prices. do you wish to continue?",
        "code": "PEX"
      },
      {
        "ean": "8018417233654",
        "message": "'Indicador  Envios  Exito' debe ser 1 o 0",
        "code": ""
      }
    ]
  }
}

Offers

Notify offer
PATCH/notifyoffer

Due our Create/Update service is a batch procces, you have to develop a service patch, where we will notify the status when offer is proccesed.

This endpoint have to send to Exito for configurate it on your user.

Example URI

PATCH /notifyoffer
Request  OK
HideShow
Headers
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Body
[
  {
    "EAN": "7701410118349",
    "Message": "OK"
  }
]
Request  KO
HideShow
Headers
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Body
[
  {
    "EAN": "7701410118035",
    "Message": "DiscountPrice is lower than Price."
  },
  {
    "EAN": "7701410118035",
    "Message": "PromiseDelivery is not correct."
  }
]
Response  200

Orders

Get orders

URLBASE: https://frgj254c3l.execute-api.us-east-1.amazonaws.com

Get Orders
GET/dev/api/orders{?culture,currentPage,dateOrderFinal,dateOrderInitial,idStatusOrder,limit,orderNumber,paginationToken}

You can consult all orders you have received through Grupo Exito’s different sites. Take into account the delivery type for further actions with these orders. All orders contain the product detail associated with them.

Example URI

GET /dev/api/orders?culture=es-CO&currentPage=1&dateOrderFinal=yyyy/MM/dd&dateOrderInitial=yyyy/MM/dd&idStatusOrder=35&limit=100&orderNumber=9202515&paginationToken={}
URI Parameters
HideShow
culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

limit
integer (required) Example: 100

Amount of expected data in the request.

currentPage
integer (optional) Example: 1

This field must be sent when the limit field changes, in order to specify the page in which it is.

dateOrderFinal
string (optional) Example: yyyy/MM/dd

Maximum date of the requested orders.

dateOrderInitial
string (optional) Example: yyyy/MM/dd

Minimum date of the requested orders.

idStatusOrder
integer (optional) Example: 35

Order status, the allowed values are: 35 (Assigned), 170 (Sent)

orderNumber
integer (optional) Example: 9202515

Asigned order number.

paginationToken
string (optional) Example: {}

This value allows to go forward in the search of the orders that fulfill the applied search criteria.

Request
HideShow
Headers
Authorization: COGNITO_TOKEN
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "viewModel": [
    {
      "id": "636979560820957673",
      "orderNumber": "678930321",
      "idSeller": 11618,
      "sellerName": "la tienda de cristian 2019 vs 5",
      "sellerNit": "300169081",
      "idChannel": 11,
      "channel": "Exito.com",
      "dateOrder": "2019-07-05T06:18:14.387-05:00",
      "idStatusOrder": 50,
      "statusOrder": "FacturadoEnviado",
      "costTotalOrder": 9000,
      "costTotalShipping": 20000,
      "codeDane": "18001000",
      "costTotalCommission": 0,
      "dateMaxDeliveryOrder": "2019-07-18T19:00:00-05:00",
      "typeDespatchOrder": "Standar  ",
      "clientName": "Leo",
      "identificationCard": "1017142034",
      "clientAddress": "cra 1 n 1-1, MEDELLIN, ANTIOQUIA, Colombia",
      "clientTelephone": "2222222",
      "dependencyId": null,
      "dependencyName": null,
      "products": [
        {
          "id": "636979560820957718",
          "idDetailProduct": 0,
          "idSeller": 0,
          "idPicking": 0,
          "internationalTracking": null,
          "nameProduct": "Reloj Inteligente Simcard Bluetooth ",
          "productId": "MP01310000000005",
          "sku": "SKUMP01310000005",
          "ean": "7752285029933",
          "reference": "smartwatch08",
          "idStatusProduct": 50,
          "statusProduct": "FacturadoEnviado",
          "quantity": 1,
          "costProduct": 9000,
          "costShippingProduct": 20000,
          "commission": 0,
          "dateMaxDeliveryProduct": "2019-07-18T19:00:00-05:00",
          "typeDespatchProduct": null,
          "tracking": "9874582",
          "carrier": "ciro",
          "dateDelivery": "2019-08-21T15:42:19.441-05:00",
          "enviosExito": false,
          "fulfillment": false,
          "color": null,
          "size": null,
          "internationalCarrier": null
        }
      ],
      "paginationToken": "636979560820957673|11618",
      "processedOrder": false,
      "allowShipping": true,
      "billUrl": null,
      "billAttachedDate": null,
      "trakingType": null,
      "urlLabel": "https://s3.amazonaws.com/seller-center-exito-staging/sticker-dev/Label_1077223218333_100004.pdf"
    }
  ],
  "count": 103,
  "paginationToken": "{\"Id\":{\"N\":\"636979560820957673\"},\"IdSeller\":{\"N\":\"11618\"}}",
  "paginationTokens": []
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "viewModel": {
      "description": "Order list that fulfill the stablished search criteria."
    },
    "count": {
      "type": "number",
      "description": "Amount of data left that has been found."
    },
    "paginationToken": {
      "type": "string",
      "description": "Pagination token obtained when browsing data. If the value is '{}' this means that all the information according to the search criteria has been found in the request. Otherwise it will indicate the position of the last found data. If the value is different to '{}', this must be stored in order to be searched in prior pages."
    },
    "paginationTokens": {
      "type": "array",
      "description": "'paginationToken' list that is obtained when chainging the amount of data to be browsed, in order to return prior data."
    }
  }
}

Sticker

Sticker
GET/dev/api/orders/{orderNumber}/sticker{?culture}

Example URI

GET /dev/api/orders/1034810209969/sticker?culture=es-CO
URI Parameters
HideShow
orderNumber
number (required) Example: 1034810209969

Order number to generate the label

culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

Request
HideShow
Headers
Authorization: COGNITO_TOKEN
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [],
  "data": "https://s3.amazonaws.com/seller-center-exito-staging/sticker-dev/Label_1077223218333_100004.pdf",
  "message": "Operación realizada con éxito",
  "pendingResponse": false
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "code": "500",
      "message": "La orden no tiene Centro de Acopio asignado"
    }
  ],
  "data": null,
  "message": "Ooops, ocurrió un error.",
  "pendingResponse": false
}

Tracking

Tracking
PATCH/dev/api/orders/{orderId}/tracking{?culture}

Example URI

PATCH /dev/api/orders/637040012650663267/tracking?culture=es-CO
URI Parameters
HideShow
culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

orderId
number (required) Example: 637040012650663267

Order ID to which the products to be sent are associated.

Request
HideShow
Headers
Authorization: COGNITO_TOKEN
Body
{
  "tracking": "787878",
  "carrier": "INTERNATIONAL SHIPPING",
  "products": [
    "6370700714712646841",
    "6370700714712646842"
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "tracking": {
      "type": "string",
      "description": "Tracking number assigned to the product being sent."
    },
    "carrier": {
      "type": "string",
      "description": "Shipping Company used to send the product."
    },
    "products": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Product ID list of all the products associated to the order to be sent. This products must be assigned in the idStatusProduct attribute with the value 35, said status can be visualized when browsing the orders."
    }
  },
  "required": [
    "tracking",
    "carrier",
    "products"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Created",
  "products": [
    {
      "idOrder": 637040012650663300,
      "idProduct": 6370700714712647000,
      "status": "Updated",
      "message": "The product 6370700714712646841 was updated.",
      "code": 201
    }
  ],
  "errors": 0,
  "updates": 1,
  "total": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Process Status."
    },
    "products": {
      "type": "array",
      "description": "Detail of the tracking number assignation for each product."
    },
    "errors": {
      "type": "number",
      "description": "Amount of found errors."
    },
    "updates": {
      "type": "number",
      "description": "Amount of correct assignations made."
    },
    "total": {
      "type": "number",
      "description": "Total of processed products."
    }
  }
}

Bill

Bill
PATCH/dev/api/orders/bill{?culture}

Example URI

PATCH /dev/api/orders/bill?culture=es-CO
URI Parameters
HideShow
culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

Request  PDF
HideShow
Headers
Authorization: COGNITO_TOKEN
Body
{
  "IdOrder": "637040012650663267",
  "Base64File": "FileInBase64",
  "FileType": 1
}
Schema
{
  "type": "object",
  "properties": {
    "IdOrder": {
      "type": "string",
      "description": "Id de la orden a la cual se le asignará la factura."
    },
    "Base64File": {
      "type": "string",
      "description": "PDF file in base 64."
    },
    "FileType": {
      "type": "number",
      "description": "1 For PDF and 2 For ZIP."
    }
  },
  "required": [
    "IdOrder",
    "Base64File",
    "FileType"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Request  ZIP
HideShow
Headers
Authorization: COGNITO_TOKEN
Body
{
  "IdOrder": "637040012650663267",
  "Base64File": "FileInBase64",
  "FileType": 2
}
Schema
{
  "type": "object",
  "properties": {
    "IdOrder": {
      "type": "string",
      "description": "Id de la orden a la cual se le asignará la factura."
    },
    "Base64File": {
      "type": "string",
      "description": "ZIP file in base 64."
    },
    "FileType": {
      "type": "number",
      "description": "1 For PDF and 2 For ZIP."
    }
  },
  "required": [
    "IdOrder",
    "Base64File",
    "FileType"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [],
  "data": true,
  "message": "File uploaded successfully."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "description": "Error list that happened in the request."
    },
    "data": {
      "type": "boolean",
      "description": "Flag that indicates if the process was completed correctly."
    },
    "message": {
      "type": "string",
      "description": "Message resulting from the process"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "errors": [
    {
      "code": "400",
      "message": "This order already has an attached invoice."
    }
  ],
  "data": false,
  "message": "This order already has an attached invoice."
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "description": "Error list that happened in the request."
    },
    "data": {
      "type": "boolean",
      "description": "Flag that indicates if the process was completed correctly."
    },
    "message": {
      "type": "string",
      "description": "Message resulting from the process."
    }
  }
}

Bills

Get Bills

URLBASE: https://iqur5b3ua3.execute-api.us-east-1.amazonaws.com/billing

Get Bills
GET/api/{?billingNumber,culture,idSeller,limit,orderNumber,paginationToken,paymentDateFinal,paymentDateInitial}

It returns a filtered list of billigs acoording to parameters.

Example URI

GET /api/?billingNumber=9406181977&culture=es-CO&idSeller=11226&limit=100&orderNumber=9202515&paginationToken={}&paymentDateFinal=2019/02/14&paymentDateInitial=2019/02/14
URI Parameters
HideShow
billingNumber
string (optional) Example: 9406181977
culture
string (required) Example: es-CO

Language in which the data is expected to arrive, the allowed values are: es-CO and en-US.

idSeller
integer (required) Example: 11226
limit
integer (required) Example: 100

Amount of expected data in the request.

orderNumber
integer (optional) Example: 9202515

Asigned order number.

paginationToken
string (required) Example: {}

This value allows to go forward in the search of the bills that fulfill the applied search criteria.

paymentDateFinal
string (optional) Example: 2019/02/14

Maximum date of the requested bills.

paymentDateInitial
string (optional) Example: 2019/02/14

Minimun date of the requested bills.

Request
HideShow
Headers
Content-Type: application/json
Authorization: COGNITO_TOKEN
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "viewModel": [
    {
      "id": 636863783488493600,
      "idBillingPicking": 1009,
      "idSeller": 11618,
      "billingNumber": "9406165195",
      "orderNumber": "704359035",
      "payOrderNumber": "6200006051",
      "concept": "Venta Marketplace",
      "paymentDate": "2019-02-08T16:44:04.677+00:00",
      "commission": 8975,
      "billingTotal": 95925,
      "iva": -1705.25,
      "detail": [
        {
          "id": 636863783488493700,
          "idBillingDetailPicking": 1036,
          "detailName": "Videojuego Grand Theft Auto V PS4",
          "ean": "MP02080000000035",
          "quantity": 1,
          "commission": 8975,
          "price": 104900,
          "shippingCost": null,
          "enviosExito": null,
          "totalShippingCost": 0
        }
      ],
      "fulfillmentDetail": null,
      "paginationToken": "636863783488493620|11618"
    }
  ],
  "count": 257,
  "paginationToken": "{\"Id\":{\"N\":\"636863783488493620\"},\"IdSeller\":{\"N\":\"11618\"}}",
  "paginationTokens": []
}

Generated by aglio on 08 Feb 2021