{ "opencollection": "1.0.0", "info": { "name": "Abuse Actions v1 API", "version": "2.0.0" }, "items": [ { "info": { "name": "v1", "type": "folder" }, "items": [ { "info": { "name": "List all abuse tickets ids that match user provided filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/abuse/tickets", "params": [ { "name": "type", "value": "", "type": "query", "description": "The type of abuse." }, { "name": "closed", "value": "", "type": "query", "description": "Is this abuse ticket closed?" }, { "name": "sourceDomainOrIp", "value": "", "type": "query", "description": "The domain name or ip address the abuse originated from" }, { "name": "target", "value": "", "type": "query", "description": "The brand/company the abuse is targeting. ie: brand name/bank name" }, { "name": "createdStart", "value": "", "type": "query", "description": "The earliest abuse ticket creation date to pull abuse tickets for" }, { "name": "createdEnd", "value": "", "type": "query", "description": "The latest abuse ticket creation date to pull abuse tickets for" }, { "name": "limit", "value": "", "type": "query", "description": "Number of abuse ticket numbers to return." }, { "name": "offset", "value": "", "type": "query", "description": "The earliest result set record number to pull abuse tickets for" } ] }, "docs": "List all abuse tickets ids that match user provided filters" }, { "info": { "name": "Create a new abuse ticket", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/abuse/tickets" }, "docs": "Create a new abuse ticket" }, { "info": { "name": "Return the abuse ticket data for a given ticket id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/abuse/tickets/:ticketId", "params": [ { "name": "ticketId", "value": "", "type": "path", "description": "A unique abuse ticket identifier" } ] }, "docs": "Return the abuse ticket data for a given ticket id" }, { "info": { "name": "Retrieve Legal Agreements for provided agreements keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agreements", "headers": [ { "name": "X-Private-Label-Id", "value": "" }, { "name": "X-Market-Id", "value": "" } ], "params": [ { "name": "keys", "value": "", "type": "query", "description": "Keys for Agreements whose details are to be retrieved" } ] }, "docs": "Retrieve Legal Agreements for provided agreements keys" }, { "info": { "name": "Create a pending order for certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates", "headers": [ { "name": "X-Market-Id", "value": "" } ] }, "docs": "

Creating a certificate order can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see '/v1/certificates/{certificateId}/callback'.

" }, { "info": { "name": "Validate a pending order for certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/validate", "headers": [ { "name": "X-Market-Id", "value": "" } ] }, "docs": "Validate a pending order for certificate" }, { "info": { "name": "Retrieve certificate details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/certificates/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to lookup" } ] }, "docs": "Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate." }, { "info": { "name": "Retrieve all certificate actions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/certificates/:certificateId/actions", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to register for callback" } ] }, "docs": "This method is used to retrieve all stateful actions relating to a certificate lifecycle." }, { "info": { "name": "Resend an email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/email/:emailId/resend", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to resend email" }, { "name": "emailId", "value": "", "type": "path", "description": "Email id for email to resend" } ] }, "docs": "This method can be used to resend emails by providing the certificate id and the email id" }, { "info": { "name": "Add alternate email address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/email/resend/:emailAddress", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to resend emails" }, { "name": "emailAddress", "value": "", "type": "path", "description": "Specific email address to resend email" } ] }, "docs": "This method adds an alternate email address to a certificate order and re-sends all existing request emails to that address." }, { "info": { "name": "Resend email to email address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/email/:emailId/resend/:emailAddress", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to resend emails" }, { "name": "emailId", "value": "", "type": "path", "description": "Email id for email to resend" }, { "name": "emailAddress", "value": "", "type": "path", "description": "Specific email address to resend email" } ] }, "docs": "This method can be used to resend emails by providing the certificate id, the email id, and the recipient email address" }, { "info": { "name": "Retrieve email history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/certificates/:certificateId/email/history", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to retrieve email history" } ] }, "docs": "This method can be used to retrieve all emails sent for a certificate." }, { "info": { "name": "Retrieve system stateful action callback url", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/certificates/:certificateId/callback", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to register for stateful action callback" } ] }, "docs": "This method is used to retrieve the registered callback url for a certificate." }, { "info": { "name": "Register of certificate action callback", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/certificates/:certificateId/callback", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to register/replace for callback" }, { "name": "callbackUrl", "value": "", "type": "query", "description": "Callback url registered/replaced to receive stateful actions" } ] }, "docs": "This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration." }, { "info": { "name": "Unregister system callback", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/certificates/:certificateId/callback", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to unregister callback" } ] }, "docs": "Unregister the callback for a particular certificate." }, { "info": { "name": "Cancel a pending certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/cancel", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to cancel" } ] }, "docs": "Use the cancel call to cancel a pending certificate order." }, { "info": { "name": "Download certificate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/certificates/:certificateId/download", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to download" } ] }, "docs": "Download certificate" }, { "info": { "name": "Reissue active certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/reissue", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to reissue" } ] }, "docs": "

Rekeying is the process by which the private and public key is changed for a certificate. It is a simplified reissue,where only the CSR is changed. Reissuing is the process by which domain names are added or removed from a certificate.Once a request is validated and approved, the certificate will be reissued with the new common name and sans specified. Unlimited reissues are available during the lifetime of the certificate.New names added to a certificate that do not share the base domain of " }, { "info": { "name": "Renew active certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/renew", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to renew" } ] }, "docs": "Renewal is the process by which the validity of a certificate is extended. Renewal is only available 60 days prior to expiration of the previous certificate and 30 days after the expiration of the previous certificate. The renewal supports modifying a set of the original certificate order information. Once a request is validated and approved, the certificate will be issued with extended validity. Since subject alternative names can be removed during a renewal, we require that you provide the sub" }, { "info": { "name": "Revoke active certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/revoke", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to revoke" } ] }, "docs": "Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned." }, { "info": { "name": "Get Site seal", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/certificates/:certificateId/siteSeal", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id" }, { "name": "theme", "value": "", "type": "query", "description": "This value represents the visual theme of the seal. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present." }, { "name": "locale", "value": "", "type": "query", "description": "Determine locale for text displayed in seal image and verification page. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present." } ] }, "docs": "

This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display w" }, { "info": { "name": "Check Domain Control", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/certificates/:certificateId/verifyDomainControl", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate id to lookup" } ] }, "docs": "Domain control is a means for verifying the domain included in the certificate order. This resource is useful for resellers that control the domains for their customers, and can expedite the verification process. See https://www.godaddy.com/help/verifying-your-domain-ownership-for-ssl-certificate-requests-html-or-dns-7452" }, { "info": { "name": "Retrieves summary country information for the provided marketId and filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/countries", "params": [ { "name": "marketId", "value": "", "type": "query", "description": "MarketId in which the request is being made, and for which responses should be localized" } ] }, "docs": "Authorization is not required" }, { "info": { "name": "Retrieves country and summary state information for provided countryKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/countries/:countryKey", "params": [ { "name": "countryKey", "value": "", "type": "path", "description": "The country key" }, { "name": "marketId", "value": "", "type": "query", "description": "MarketId in which the request is being made, and for which responses should be localized" } ] }, "docs": "Authorization is not required" }, { "info": { "name": "Retrieve a list of Domains for the specified Shopper", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "statuses", "value": "", "type": "query", "description": "Only include results with `status` value in the specified set" }, { "name": "statusGroups", "value": "", "type": "query", "description": "Only include results with `status` value in any of the specified groups" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of domains to return" }, { "name": "marker", "value": "", "type": "query", "description": "Marker Domain to use as the offset in results" }, { "name": "includes", "value": "", "type": "query", "description": "Optional details to be included in the response" }, { "name": "modifiedDate", "value": "", "type": "query", "description": "Only include results that have been modified since the specified date" } ] }, "docs": "Retrieve a list of Domains for the specified Shopper" }, { "info": { "name": "Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/agreements", "headers": [ { "name": "X-Market-Id", "value": "" } ], "params": [ { "name": "tlds", "value": "", "type": "query", "description": "list of TLDs whose legal agreements are to be retrieved" }, { "name": "privacy", "value": "", "type": "query", "description": "Whether or not privacy has been requested" }, { "name": "forTransfer", "value": "", "type": "query", "description": "Whether or not domain tranfer has been requested" } ] }, "docs": "Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons" }, { "info": { "name": "Determine whether or not the specified domain is available for purchase", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/available", "params": [ { "name": "domain", "value": "", "type": "query", "description": "Domain name whose availability is to be checked" }, { "name": "checkType", "value": "", "type": "query", "description": "Optimize for time ('FAST') or accuracy ('FULL')" }, { "name": "forTransfer", "value": "", "type": "query", "description": "Whether or not to include domains available for transfer. If set to True, checkType is ignored" } ] }, "docs": "Determine whether or not the specified domain is available for purchase" }, { "info": { "name": "Determine whether or not the specified domains are available for purchase", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/available", "params": [ { "name": "checkType", "value": "", "type": "query", "description": "Optimize for time ('FAST') or accuracy ('FULL')" } ] }, "docs": "Determine whether or not the specified domains are available for purchase" }, { "info": { "name": "Validate the request body using the Domain Contact Validation Schema for specified domains.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/contacts/validate", "headers": [ { "name": "X-Private-Label-Id", "value": "" } ], "params": [ { "name": "marketId", "value": "", "type": "query", "description": "MarketId in which the request is being made, and for which responses should be localized" } ] }, "docs": "All contacts specified in request will be validated against all domains specifed in \"domains\". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names" }, { "info": { "name": "Purchase and register the specified Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/purchase", "headers": [ { "name": "X-Shopper-Id", "value": "" } ] }, "docs": "Purchase and register the specified Domain" }, { "info": { "name": "Retrieve the schema to be submitted when registering a Domain for the specified TLD", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/purchase/schema/:tld", "params": [ { "name": "tld", "value": "", "type": "path", "description": "The Top-Level Domain whose schema should be retrieved" } ] }, "docs": "Retrieve the schema to be submitted when registering a Domain for the specified TLD" }, { "info": { "name": "Validate the request body using the Domain Purchase Schema for the specified TLD", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/purchase/validate" }, "docs": "Validate the request body using the Domain Purchase Schema for the specified TLD" }, { "info": { "name": "Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/suggest", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "query", "value": "", "type": "query", "description": "Domain name or set of keywords for which alternative domain names will be suggested" }, { "name": "country", "value": "", "type": "query", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore" }, { "name": "city", "value": "", "type": "query", "description": "Name of city to be used as a hint for target region" }, { "name": "sources", "value": "", "type": "query", "description": "Sources to be queried

" }, { "name": "tlds", "value": "", "type": "query", "description": "Top-level domains to be included in suggestions

\nNOTE: These are sample values, there are many\nmore" }, { "name": "lengthMax", "value": "", "type": "query", "description": "Maximum length of second-level domain" }, { "name": "lengthMin", "value": "", "type": "query", "description": "Minimum length of second-level domain" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of suggestions to return" }, { "name": "waitMs", "value": "", "type": "query", "description": "Maximum amount of time, in milliseconds, to wait for responses\nIf elapses, return the results compiled up to that point" } ] }, "docs": "Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history" }, { "info": { "name": "Retrieves a list of TLDs supported and enabled for sale", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/tlds" }, "docs": "Retrieves a list of TLDs supported and enabled for sale" }, { "info": { "name": "Retrieve details for the specified Domain", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/:domain", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain name whose details are to be retrieved" } ] }, "docs": "Retrieve details for the specified Domain" }, { "info": { "name": "Update details for the specified Domain", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/domains/:domain", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose details are to be updated" } ] }, "docs": "Update details for the specified Domain" }, { "info": { "name": "Cancel a purchased domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/domains/:domain", "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain to cancel" } ] }, "docs": "Cancel a purchased domain" }, { "info": { "name": "Update domain", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/domains/:domain/contacts", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose Contacts are to be updated." } ] }, "docs": "Update domain" }, { "info": { "name": "Submit a privacy cancellation request for the given domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/domains/:domain/privacy", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose privacy is to be cancelled" } ] }, "docs": "Submit a privacy cancellation request for the given domain" }, { "info": { "name": "Purchase privacy for a specified domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/:domain/privacy/purchase", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain for which to purchase privacy" } ] }, "docs": "Purchase privacy for a specified domain" }, { "info": { "name": "Replace all DNS Records for the specified Domain", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/domains/:domain/records", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose DNS Records are to be replaced" } ] }, "docs": "Replace all DNS Records for the specified Domain" }, { "info": { "name": "Add the specified DNS Records to the specified Domain", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/domains/:domain/records", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose DNS Records are to be augmented" } ] }, "docs": "Add the specified DNS Records to the specified Domain" }, { "info": { "name": "Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/:domain/records/:type/:name", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose DNS Records are to be retrieved" }, { "name": "type", "value": "", "type": "path", "description": "DNS Record Type for which DNS Records are to be retrieved" }, { "name": "name", "value": "", "type": "path", "description": "DNS Record Name for which DNS Records are to be retrieved" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" } ] }, "docs": "Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name" }, { "info": { "name": "Replace all DNS Records for the specified Domain with the specified Type and Name", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/domains/:domain/records/:type/:name", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose DNS Records are to be replaced" }, { "name": "type", "value": "", "type": "path", "description": "DNS Record Type for which DNS Records are to be replaced" }, { "name": "name", "value": "", "type": "path", "description": "DNS Record Name for which DNS Records are to be replaced" } ] }, "docs": "Replace all DNS Records for the specified Domain with the specified Type and Name" }, { "info": { "name": "Delete all DNS Records for the specified Domain with the specified Type and Name", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/domains/:domain/records/:type/:name", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose DNS Records are to be deleted" }, { "name": "type", "value": "", "type": "path", "description": "DNS Record Type for which DNS Records are to be deleted" }, { "name": "name", "value": "", "type": "path", "description": "DNS Record Name for which DNS Records are to be deleted" } ] }, "docs": "Delete all DNS Records for the specified Domain with the specified Type and Name" }, { "info": { "name": "Replace all DNS Records for the specified Domain with the specified Type", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/domains/:domain/records/:type", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose DNS Records are to be replaced" }, { "name": "type", "value": "", "type": "path", "description": "DNS Record Type for which DNS Records are to be replaced" } ] }, "docs": "Replace all DNS Records for the specified Domain with the specified Type" }, { "info": { "name": "Renew the specified Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/:domain/renew", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain to renew" } ] }, "docs": "Renew the specified Domain" }, { "info": { "name": "Purchase and start or restart transfer process", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/:domain/transfer", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain to transfer in" } ] }, "docs": "Purchase and start or restart transfer process" }, { "info": { "name": "Re-send Contact E-mail Verification for specified Domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/:domain/verifyRegistrantEmail", "headers": [ { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "domain", "value": "", "type": "path", "description": "Domain whose Contact E-mail should be verified." } ] }, "docs": "Re-send Contact E-mail Verification for specified Domain" }, { "info": { "name": "Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/orders", "headers": [ { "name": "X-Shopper-Id", "value": "" }, { "name": "X-App-Key", "value": "" } ], "params": [ { "name": "periodStart", "value": "", "type": "query", "description": "Start of range indicating what time-frame should be returned. Inclusive" }, { "name": "periodEnd", "value": "", "type": "query", "description": "End of range indicating what time-frame should be returned. Inclusive" }, { "name": "domain", "value": "", "type": "query", "description": "Domain name to use as the filter of results" }, { "name": "productGroupId", "value": "", "type": "query", "description": "Product group id to use as the filter of results" }, { "name": "paymentProfileId", "value": "", "type": "query", "description": "Payment profile id to use as the filter of results" }, { "name": "parentOrderId", "value": "", "type": "query", "description": "Parent order id to use as the filter of results" }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "sort", "value": "", "type": "query", "description": "Property name that will be used to sort results. '-' indicates descending" } ] }, "docs": "API Resellers" }, { "info": { "name": "Retrieve details for specified order", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/orders/:orderId", "headers": [ { "name": "X-Shopper-Id", "value": "" }, { "name": "X-Market-Id", "value": "" }, { "name": "X-App-Key", "value": "" } ], "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Order id whose details are to be retrieved" } ] }, "docs": "API Resellers" }, { "info": { "name": "Create a Subaccount owned by the authenticated Reseller", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shoppers/subaccount" }, "docs": "Create a Subaccount owned by the authenticated Reseller" }, { "info": { "name": "Get details for the specified Shopper", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shoppers/:shopperId", "params": [ { "name": "shopperId", "value": "", "type": "path", "description": "Shopper whose details are to be retrieved" }, { "name": "includes", "value": "", "type": "query", "description": "Additional properties to be included in the response shopper object" } ] }, "docs": "Notes:" }, { "info": { "name": "Update details for the specified Shopper", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shoppers/:shopperId", "params": [ { "name": "shopperId", "value": "", "type": "path", "description": "The ID of the Shopper to update" } ] }, "docs": "Notes:" }, { "info": { "name": "Request the deletion of a shopper profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/shoppers/:shopperId", "params": [ { "name": "shopperId", "value": "", "type": "path", "description": "The ID of the shopper to delete. Must agree with the shopper id on the token or header, if present. *Note*: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)" }, { "name": "auditClientIp", "value": "", "type": "query", "description": "The client IP of the user who originated the request leading to this call." } ] }, "docs": "Notes:" }, { "info": { "name": "Get details for the specified Shopper", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shoppers/:shopperId/status", "params": [ { "name": "shopperId", "value": "", "type": "path", "description": "The ID of the shopper to retrieve. Must agree with the shopper id on the token or header, if present" }, { "name": "auditClientIp", "value": "", "type": "query", "description": "The client IP of the user who originated the request leading to this call." } ] }, "docs": "Notes:" }, { "info": { "name": "Set subaccount's password", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/shoppers/:shopperId/factors/password", "params": [ { "name": "shopperId", "value": "", "type": "path", "description": "Shopper whose password will be set" } ] }, "docs": "Notes:" }, { "info": { "name": "Retrieve a list of Subscriptions for the specified Shopper", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions", "headers": [ { "name": "X-App-Key", "value": "" }, { "name": "X-Shopper-Id", "value": "" }, { "name": "X-Market-Id", "value": "" } ], "params": [ { "name": "productGroupKeys", "value": "", "type": "query", "description": "Only return Subscriptions with the specified product groups" }, { "name": "includes", "value": "", "type": "query", "description": "Optional details to be included in the response" }, { "name": "offset", "value": "", "type": "query", "description": "Number of Subscriptions to skip before starting to return paged results (must be a multiple of the limit)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of Subscriptions to retrieve in this page, starting after offset" }, { "name": "sort", "value": "", "type": "query", "description": "Property name that will be used to sort results. \"-\" indicates descending" } ] }, "docs": "Retrieve a list of Subscriptions for the specified Shopper" }, { "info": { "name": "Retrieve a list of ProductGroups for the specified Shopper", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/productGroups", "headers": [ { "name": "X-App-Key", "value": "" }, { "name": "X-Shopper-Id", "value": "" } ] }, "docs": "Retrieve a list of ProductGroups for the specified Shopper" }, { "info": { "name": "Retrieve details for the specified Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/:subscriptionId", "headers": [ { "name": "X-App-Key", "value": "" }, { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Unique identifier of the Subscription to retrieve" } ] }, "docs": "Retrieve details for the specified Subscription" }, { "info": { "name": "Update details for the specified Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/subscriptions/:subscriptionId", "headers": [ { "name": "X-App-Key", "value": "" }, { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Unique identifier of the Subscription to update" } ] }, "docs": "Only Subscription properties that can be changed without immediate financial impact can be modified via PATCH, whereas some properties can be changed by purchasing a renewal
This endpoint only supports JWT authentication" }, { "info": { "name": "Cancel the specified Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/subscriptions/:subscriptionId", "headers": [ { "name": "X-App-Key", "value": "" }, { "name": "X-Shopper-Id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Unique identifier of the Subscription to cancel" } ] }, "docs": "Cancel the specified Subscription" } ] } ], "bundled": true }