apI
  1. Public Order
apI
  • Emole Developer FrontEnd APi EndPoints
    • Authintication
    • Api Flow Chart
    • Public Back In Stock Subscription
      • Subscribe to back in stock product
      • Get customer back in stock subscriptions
      • Opt out from back in stock subscriptions
      • Prepare back in stock subscription model
    • Public Blog
      • Get all blog posts
      • Get all blog post tags
      • Get all blog post months
      • Get blog post
      • Add comment to a blog post
    • Public Category
      • Get categories to be displayed on home page
      • Get main top menu
      • Get specific category
      • Get category products
      • Get all root categories
      • Get all sub categories of the specified category
    • Public Checkout
      • Get order summary
      • Get all billing addresses
      • Select billing address
      • Add a new billing address
      • Get all pickup points
      • Get all shipping addresses
      • Select shipping address
      • Add a new shipping address
      • Get all shipping methods
      • Select shipping method
      • Get all payment methods
      • Select payment method
      • Prepare payment info model
      • Validate the payment info
      • Prepare confirm order model
      • Confirm and pay the order
      • Get completed order info
    • Public Common
      • Get all states of specific country
      • Get all languages
      • Set working language
      • Get all currencies
      • Set working currency
      • Get all tax types
      • Set tax display type
      • Find entity
    • Public Customer
      • Impersonate a customer
      • Get guest token to continue as a guest
      • Prepare login model
      • Login
      • Logout
      • Refresh access token on expiration
      • Prepare password recovery model
      • Submit password recovery request
      • Prepare the customer registration model
      • Submit the customer register request
      • Check username availability
      • Prepare customer navigation model
      • Get the customer info
      • Update the customer info
      • Delete the external authentication record
      • Get customer addresses
      • Delete the customer address
      • Prepare the add new customer address model
      • Add a new customer address
      • Get specific customer address
      • Update the customer address
      • Get the customer downloadable products
      • Get user agreement
      • Prepare change password model
      • Submit the change password request
      • Get customer avatar
      • Upload customer avatar
      • Remove customer avatar
      • Prepare GDPR tools model
      • Export customer GDPR info
      • Delete request of GDPR info
      • Prepare check gift card balance model
      • Check gift card balance
    • Public Download
      • Download product sample
      • Download the downloadable product
      • Download the order license
      • Download the file upload file
      • Download the order note file
    • Public Forum
      • Get all forums
      • Get all active discussions
      • Get active discussions in small for forum's index page
      • Get specific forum group
      • Get specific forum
      • Watch/Unwatch forum
      • Get specific forum topic
      • Watch/Unwatch forum topic
      • Prepare the move topic model
      • Move topic to another forum
      • Delete topic
      • Prepare create topic model
      • Create a new forum topic
      • Prepare edit topic model
      • Update the forum topic
      • Delete the post
      • Prepare create post model
      • Create a new forum topic post
      • Prepare edit post model
      • Update the post
      • Vote the post
      • Get last/latest post
      • Search into forum
      • Get customer forum subscriptions
      • Delete customer forum subscriptions
      • Prepare customer profile model
    • Public General
      • Get Topic
        • Get the specific topic(page) by topic identifier
        • Get the specific topic(page) by system name
      • Ping to check the api server status
      • Get all locale string resources
      • Get all settings of current store
      • Get header links info
      • Get footer info
      • Get polls to be displayed on home page
      • Vote a poll
      • Get all topics
      • Authenticate the topic(page)
      • Get nivo slider images(plugin)
      • Prepare the contact us model
      • Submit the contact us request
      • Prepare the contact vendor model
      • Submit the contact vendor request
      • Prepare newsletter box model
      • Subscribe to the news letters
    • Public Manufacturer
      • Prepare the manufacturer model
      • Get all manufacturers
      • Get manufacturer products
    • Public News
      • Get news to be displayed on home page
      • Get all news of the current store
      • Get specific news item
      • Add a new news item comment
    • Public Order
      • Get customer orders
        GET
      • Cancel recurring payment
        POST
      • Retry last recurring payment
        POST
      • Get customer reward points
        GET
      • Get specific order details
        GET
      • Get order invoice in pdf format
        GET
      • Re-order
        POST
      • Retry payment (Only redirection payment method type supported by nopCommerce)
        POST
      • Get specific shipment details
        GET
    • Public Private Messages
      • Get specific private message
      • Get all inbox messages
      • Get all sent messages
      • Delete inbox messages (selected)
      • Mark messages as unread (selected)
      • Delete sent messages (selected)
      • Prepare send message model
      • Send private message
      • Delete a private message
    • Public Product
      • Get products to be displayed on home page
      • Get best selling products
      • Get a product details
      • Change and apply product attributes
      • Estimate shipping
      • Get product combinations
      • Get marked as new products
      • Get product reviews
      • Add a new product review
      • Set product review helpfulness
      • Get customer product reviews
      • Prepare product email a friend model
      • Email the product to a friend
      • Get popular product tags
      • Get products by tag
      • Get related products
      • Get cross sell products
      • Get also purchased products
    • Public Return Request
      • Get customer return requests
      • Prepare return request model
      • Submit a return request
      • Upload a return request file
    • Public Search
      • Get search term auto complete response
      • Prepare search model
      • Search products
    • Public Shopping Cart
      • Get selected checkout attributes
      • Change and apply checkout attributes
      • Upload product attribute file
      • Upload checkout attribute file
      • Get customer cart
      • Delete cart items
      • Update quantities of the cart items
      • Add product to the cart
      • Apply discount coupon
      • Apply gift card coupon
      • Prepare estimate shipping model
      • Estimate shipping
      • Select shipping option
      • Remove discount coupon
      • Remove gift card coupon
      • Get order totals
      • Start checkout (to validate cart and go on checkout page)
      • Get customer wish list
      • Add product to wish list
      • Delete wish list items
      • Update quantities of wish list items
      • Move wish list items to cart
      • Prepare email wish list model
      • Send wish list link on email
    • Public Vendor
      • Prepare vendor model
      • Get vendor products
      • Get all vendors
      • Prepare apply for vendor model
      • Submit apply for vendor request
      • Prepare vendor info model
      • Update vendor info
      • Remove vendor picture
  • Emole Developer BackEnd Api
    • categories
      • {id}
        • Get Category By Id
        • Update Category
        • Delete Category
      • Get Categories
      • Create Category
      • Get Categories Count
    • customers
      • {id}
        • Get Customer By Id
        • Update Customer
        • Delete Customer
      • {customer Id}
        • Set Billing Address
        • Set Shipping Address
      • Get Customers
      • Create Customer
      • Get Current Customer
      • Get Customers Count
      • Search Customers
    • languages
      • current
        • Get Current Language
        • Set Current Language
      • Get All Languages
    • manufacturers
      • {id}
        • Get Manufacturer By Id
        • Update Manufacturer
        • Delete Manufacturer
      • Get Manufacturers
      • Create Manufacturer
      • Get Manufacturers Count
    • news letter subscriptions
      • Get News Letter Subscriptions
      • Deactivate News Letter Subscription
    • orders
      • {order Id}
        • items
          • {order Item Id}
            • Get Order Item By Id For Order
            • Update Order Item
            • Delete Order Item By Id
          • Get Order Items
          • Create Order Item
          • Delete All Order Items For Order
          • Get Order Items Count
        • Get Pdf Invoice
      • {id}
        • Get Order By Id
        • Update Order
        • Delete Order
      • Get Orders
      • Create Order
      • Get Orders Count
      • Get Orders By Customer Id
    • productattributes
      • {id}
        • Get Product Attribute By Id
        • Update Product Attribute
        • Delete Product Attribute
      • Get Product Attributes
      • Create Product Attribute
      • Get Product Attributes Count
    • product category mappings
      • {id}
        • Get Product Category Mapping By Id
        • Update Product Category Mapping
        • Delete Product Category Mapping
      • Get Product Category Mappings
      • Create Product Category Mapping
      • Get Product Category Mappings Count
    • product manufacturer mappings
      • {id}
        • Get Product Manufacturer Mapping By Id
        • Update Product Manufacturer Mapping
        • Delete Product Manufacturer Mapping
      • Get Product Manufacturer Mappings
      • Create Product Manufacturer Mapping
      • Get Product Manufacturer Mappings Count
    • products
      • {id}
        • Get Product By Id
        • Update Product
        • Delete Product
      • Get Products
      • Create Product
      • Get Products Count
    • productspecificationattributes
      • {id}
        • Get Product Specification Attribute By Id
        • Update Product Specification Attribute
        • Delete Product Specification Attribute
      • Get Product Specification Attributes
      • Create Product Specification Attribute
      • Get Product Specification Attributes Count
    • shopping cart items
      • {id}
        • Update Shopping Cart Item
        • Delete Shopping Cart Item
      • Get Shopping Cart Items
      • Create Shopping Cart Item
      • Delete Shopping Cart Items
      • Get Current Shopping Cart
      • Batch Create Shopping Cart Items
    • specificationattributes
      • {id}
        • Get Specification Attribute By Id
        • Update Specification Attribute
        • Delete Specification Attribute
      • Get Specification Attributes
      • Create Specification Attribute
      • Get Specification Attributes Count
    • topics
      • {id}
        • Get Topic By Id
        • Update Topic
        • Delete Topic
      • Get Topics
      • Create Topic
    • token
      • Request Token
      • Validate Token
    • Get Countries
    • Get All Customer Roles
    • Get Current Store
    • Get All Stores
  1. Public Order

Cancel recurring payment

POST
/api/PublicOrder/CancelRecurringPayment/{recurringPaymentId}
Last modified:2023-09-13 15:55:50

Request

Authorization
Add parameter in header
Example:
X-Token: ********************
Path Params
recurringPaymentId
string 
required
(Required) The recurring payment identifier
Example:
-95421061
Header Params
Accept
string 
required
Example:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://test.e-mole.net/api/PublicOrder/CancelRecurringPayment/-95421061' \
--header 'Accept: application/json'

Responses

🟢200Success
application/json
Body
Orders
array [object {10}] 
required
CustomOrderNumber
string 
required
OrderTotal
string 
required
IsReturnRequestAllowed
boolean 
required
OrderStatusEnum
object 
required
OrderStatus
string 
required
PaymentStatus
string 
required
ShippingStatus
string 
required
CreatedOn
string 
required
Id
integer 
required
CustomProperties
object 
required
RecurringOrders
array [object {11}] 
required
StartDate
string 
required
CycleInfo
string 
required
NextPayment
string 
required
TotalCycles
integer 
required
CyclesRemaining
integer 
required
InitialOrderId
integer 
required
CanRetryLastPayment
boolean 
required
InitialOrderNumber
string 
required
CanCancel
boolean 
required
Id
integer 
required
CustomProperties
object 
required
RecurringPaymentErrors
array[string]
required
CustomProperties
object 
required
mollit__7
object 
required
consectetur_cd
object 
required
non3a
object 
required
sitf52
object 
required
Example
{
  "Orders": [
    {
      "CustomOrderNumber": "nisi sint non culpa",
      "OrderTotal": "ea",
      "IsReturnRequestAllowed": false,
      "OrderStatusEnum": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "OrderStatus": "in adipisicing",
      "PaymentStatus": "fugiat sunt eu proident",
      "ShippingStatus": "in laborum dolor officia enim",
      "CreatedOn": "1947-05-18T02:46:26.402Z",
      "Id": -11465112,
      "CustomProperties": {
        "aliquip31b": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "ex1f": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    },
    {
      "CustomOrderNumber": "culpa eu aliqua est",
      "OrderTotal": "deserunt",
      "IsReturnRequestAllowed": true,
      "OrderStatusEnum": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "OrderStatus": "velit mollit",
      "PaymentStatus": "nulla proident",
      "ShippingStatus": "minim ut in",
      "CreatedOn": "1959-10-15T11:01:10.011Z",
      "Id": 99438220,
      "CustomProperties": {
        "tempor_7": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  ],
  "RecurringOrders": [
    {
      "StartDate": "laboris",
      "CycleInfo": "aute nulla nostrud sed officia",
      "NextPayment": "et consectetur dolor sunt dolore",
      "TotalCycles": -28031868,
      "CyclesRemaining": -23603124,
      "InitialOrderId": 193323,
      "CanRetryLastPayment": true,
      "InitialOrderNumber": "ipsum Excepteur",
      "CanCancel": true,
      "Id": 92377527,
      "CustomProperties": {
        "commodod1": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    },
    {
      "StartDate": "ea fugiat",
      "CycleInfo": "elit fugiat labore exercitation",
      "NextPayment": "consectetur quis est tempor",
      "TotalCycles": -91864830,
      "CyclesRemaining": -97722071,
      "InitialOrderId": -25671677,
      "CanRetryLastPayment": true,
      "InitialOrderNumber": "et amet exercitation commodo voluptate",
      "CanCancel": false,
      "Id": -32469092,
      "CustomProperties": {
        "consecteturf": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "nulla5c_": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "officia_": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  ],
  "RecurringPaymentErrors": [
    "incididunt in voluptate consectetur",
    "fugiat consectetur"
  ],
  "CustomProperties": {
    "mollit__7": {},
    "consectetur_cd": {},
    "non3a": {},
    "sitf52": {}
  }
}
🟠400Bad Request
🟠401Unauthorized
🟠404Not Found
Modified at 2023-09-13 15:55:50
Previous
Get customer orders
Next
Retry last recurring payment