mercadopago.resources.merchant_order API documentation
Description: Module: merchant_order

# Module `mercadopago.resources.merchant_order`

Module: merchant_order

Expand source code

    """
        Module: merchant_order
    """
    from mercadopago.core import MPBase

    class MerchantOrder(MPBase):
        """
        This class will allow you to create and manage your orders. You can attach
        one or more payments in your merchant order.
        """

        def search(self, filters=None, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long

            Args:
                filters (dict): The search filters parameters
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Returns:
                dict: Merchant Order find response
            """
            return self._get(uri="/merchant_orders/search", filters=filters,
                             request_options=request_options)

        def get(self, merchan_order_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long

            Args:
                merchan_order_id (str): The Merchant Order ID
                request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

            Returns:
                dict: Cards find response
            """
            return self._get(uri="/merchant_orders/" + str(merchan_order_id),
                             request_options=request_options)

        def update(self, merchan_order_id, merchant_order_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long

            Args:
                merchan_order_id (str): Merchant Order ID
                merchant_order_object (dict): Merchant Order object to be updated
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
                ValueError: Param merchant_order_object must be a Dictionary

            Returns:
                dict: Cards modification response
            """
            if not isinstance(merchant_order_object, dict):
                raise ValueError(
                    "Param merchant_order_object must be a Dictionary")

            return self._put(uri="/merchant_orders/" + str(merchan_order_id),
                             data=merchant_order_object, request_options=request_options)

        def create(self, merchant_order_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long

            Args:
                merchant_order_object (dict): Merchant Order object to be created
                request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass
                    changing or adding custom options to ur REST call. Defaults to None.

            Raises:
                ValueError: Param merchant_order_object must be a Dictionary

            Returns:
                dict: Cards creation response
            """
            if not isinstance(merchant_order_object, dict):
                raise ValueError(
                    "Param merchant_order_object must be a Dictionary")

            return self._post(uri="/merchant_orders", data=merchant_order_object,
                              request_options=request_options)

## Classes

`class MerchantOrder (request_options, http_client)`

  This class will allow you to create and manage your orders. You can attach one or more payments in your merchant order.

  Expand source code

      class MerchantOrder(MPBase):
          """
          This class will allow you to create and manage your orders. You can attach
          one or more payments in your merchant order.
          """

          def search(self, filters=None, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long

              Args:
                  filters (dict): The search filters parameters
                  request_options (mercadopago.config.request_options, optional): An instance of
                  RequestOptions can be pass changing or adding custom options to ur REST call.
                  Defaults to None.

              Returns:
                  dict: Merchant Order find response
              """
              return self._get(uri="/merchant_orders/search", filters=filters,
                               request_options=request_options)

          def get(self, merchan_order_id, request_options=None):
              """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long

              Args:
                  merchan_order_id (str): The Merchant Order ID
                  request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

              Returns:
                  dict: Cards find response
              """
              return self._get(uri="/merchant_orders/" + str(merchan_order_id),
                               request_options=request_options)

          def update(self, merchan_order_id, merchant_order_object, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long

              Args:
                  merchan_order_id (str): Merchant Order ID
                  merchant_order_object (dict): Merchant Order object to be updated
                  request_options (mercadopago.config.request_options, optional): An instance of
                  RequestOptions can be pass changing or adding custom options to ur REST call.
                  Defaults to None.

              Raises:
                  ValueError: Param merchant_order_object must be a Dictionary

              Returns:
                  dict: Cards modification response
              """
              if not isinstance(merchant_order_object, dict):
                  raise ValueError(
                      "Param merchant_order_object must be a Dictionary")

              return self._put(uri="/merchant_orders/" + str(merchan_order_id),
                               data=merchant_order_object, request_options=request_options)

          def create(self, merchant_order_object, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long

              Args:
                  merchant_order_object (dict): Merchant Order object to be created
                  request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass
                      changing or adding custom options to ur REST call. Defaults to None.

              Raises:
                  ValueError: Param merchant_order_object must be a Dictionary

              Returns:
                  dict: Cards creation response
              """
              if not isinstance(merchant_order_object, dict):
                  raise ValueError(
                      "Param merchant_order_object must be a Dictionary")

              return self._post(uri="/merchant_orders", data=merchant_order_object,
                                request_options=request_options)

  ### Ancestors

  - MPBase

  ### Methods

  `def create(self, merchant_order_object, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `merchant_order_object` :`dict`
      Merchant Order object to be created
    `request_options` :`mercadopago.config.request_options`, optional
      An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    ## Raises

    `ValueError`
      Param merchant_order_object must be a Dictionary

    ## Returns

    `dict`
      Cards creation response
    Expand source code

        def create(self, merchant_order_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long

            Args:
                merchant_order_object (dict): Merchant Order object to be created
                request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass
                    changing or adding custom options to ur REST call. Defaults to None.

            Raises:
                ValueError: Param merchant_order_object must be a Dictionary

            Returns:
                dict: Cards creation response
            """
            if not isinstance(merchant_order_object, dict):
                raise ValueError(
                    "Param merchant_order_object must be a Dictionary")

            return self._post(uri="/merchant_orders", data=merchant_order_object,
                              request_options=request_options)

  `def get(self, merchan_order_id, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `merchan_order_id` :`str`
      The Merchant Order ID
    `request_options` :`mercadopago.config.request_options`, optional
      An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    ## Returns

    `dict`
      Cards find response
    Expand source code

        def get(self, merchan_order_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long

            Args:
                merchan_order_id (str): The Merchant Order ID
                request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

            Returns:
                dict: Cards find response
            """
            return self._get(uri="/merchant_orders/" + str(merchan_order_id),
                             request_options=request_options)

  `def search(self, filters=None, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `filters` :`dict`
      The search filters parameters
    `request_options` :`mercadopago.config.request_options`, optional
      An instance of

    RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    ## Returns

    `dict`
      Merchant Order find response
    Expand source code

        def search(self, filters=None, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long

            Args:
                filters (dict): The search filters parameters
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Returns:
                dict: Merchant Order find response
            """
            return self._get(uri="/merchant_orders/search", filters=filters,
                             request_options=request_options)

  `def update(self, merchan_order_id, merchant_order_object, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `merchan_order_id` :`str`
      Merchant Order ID
    `merchant_order_object` :`dict`
      Merchant Order object to be updated
    `request_options` :`mercadopago.config.request_options`, optional
      An instance of

    RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    ## Raises

    `ValueError`
      Param merchant_order_object must be a Dictionary

    ## Returns

    `dict`
      Cards modification response
    Expand source code

        def update(self, merchan_order_id, merchant_order_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long

            Args:
                merchan_order_id (str): Merchant Order ID
                merchant_order_object (dict): Merchant Order object to be updated
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
                ValueError: Param merchant_order_object must be a Dictionary

            Returns:
                dict: Cards modification response
            """
            if not isinstance(merchant_order_object, dict):
                raise ValueError(
                    "Param merchant_order_object must be a Dictionary")

            return self._put(uri="/merchant_orders/" + str(merchan_order_id),
                             data=merchant_order_object, request_options=request_options)

  ### Inherited members

  - `MPBase`:
    - `config`
    - `request_options`