{ "opencollection": "1.0.0", "info": { "name": "Commerce Partner API", "version": "1.0.0" }, "items": [ { "info": { "name": "Customer Accounts", "type": "folder" }, "items": [ { "info": { "name": "Create Customer Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/customers" }, "docs": "Prior to an order being placed, a Reseller creates an account for a Customer and the marketplace calls Create Customer Account. The customer resource is returned with link to Get Customer Account Details" }, { "info": { "name": "Get Customer Account Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/customers/:customer-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Finds specified customer account by account ID." }, { "info": { "name": "Update Customer Account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/customers/:customer-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "The end customer’s address and contact information can be updated through a call to Update Customer Account." }, { "info": { "name": "Create Customer Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/customers" }, "docs": "Prior to an order being placed, a Reseller creates an account for a Customer and the marketplace calls Create Customer Account. The customer resource is returned with link to Get Customer Account Details" }, { "info": { "name": "Get Customer Account Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/customers/:customer-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Finds specified customer account by account ID." }, { "info": { "name": "Update Customer Account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v3/customers/:customer-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "The end customer’s address and contact information can be updated through a call to Update Customer Account." } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Preview an order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/customers/:customer-id/orderpreviews", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Preview an order" }, { "info": { "name": "Get Order History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/customers/:customer-id/orders", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Get Order History" }, { "info": { "name": "Creates an order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/customers/:customer-id/orders", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Creates an order" }, { "info": { "name": "Get Order Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/customers/:customer-id/orders/:order-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "order-id", "value": "", "type": "path", "description": "order-id" } ] }, "docs": "Get Order Details" }, { "info": { "name": "Cancel Order", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/customers/:customer-id/orders/:order-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "order-id", "value": "", "type": "path", "description": "order-id" } ] }, "docs": "Cancel an Order for a Customer" }, { "info": { "name": "Get Order History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/customers/:customer-id/orders", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "end-date", "value": "", "type": "query", "description": "end-date" }, { "name": "limit", "value": "", "type": "query", "description": "limit" }, { "name": "offer-id", "value": "", "type": "query", "description": "offer-id" }, { "name": "offset", "value": "", "type": "query", "description": "offset" }, { "name": "order-type", "value": "", "type": "query", "description": "order-type" }, { "name": "reference-order-id", "value": "", "type": "query", "description": "reference-order-id" }, { "name": "start-date", "value": "", "type": "query", "description": "start-date" }, { "name": "status", "value": "", "type": "query", "description": "status" }, { "name": "subscription-id", "value": "", "type": "query", "description": "subscription-id" } ] }, "docs": "Get Order History" }, { "info": { "name": "Creates an order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/customers/:customer-id/orders", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Creates an order" }, { "info": { "name": "Get Order Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/customers/:customer-id/orders/:order-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "order-id", "value": "", "type": "path", "description": "order-id" } ] }, "docs": "Get Order Details" }, { "info": { "name": "Update externalReferenceId of order", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v3/customers/:customer-id/orders/:order-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "order-id", "value": "", "type": "path", "description": "order-id" } ] }, "docs": "Update externalReferenceId of Order" } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Get All Subscriptions for a Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/customers/:customer-id/subscriptions", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Get All Subscriptions for a Customer with a corresponding Customer ID." }, { "info": { "name": "Get Subscription Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/customers/:customer-id/subscriptions/:subscription-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "subscription-id", "value": "", "type": "path", "description": "subscription-id" } ] }, "docs": "Get Subscription Details with corresponding Customer ID and Subsciption ID. Can receive the current quantity, autorenewal status, creation date, and more." }, { "info": { "name": "Update Subscription Auto-Renewal", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/customers/:customer-id/subscriptions/:subscription-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "subscription-id", "value": "", "type": "path", "description": "subscription-id" } ] }, "docs": "Update the auto renewal status and quantity of licenses to renew. Subscriptions that are created by an order will be set to auto-renew by default." }, { "info": { "name": "Get All Subscriptions for a Customer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/customers/:customer-id/subscriptions", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" } ] }, "docs": "Get All Subscriptions for a Customer with a corresponding Customer ID." }, { "info": { "name": "Get Subscription Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/customers/:customer-id/subscriptions/:subscription-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "subscription-id", "value": "", "type": "path", "description": "subscription-id" } ] }, "docs": "Get Subscription Details with corresponding Customer ID and Subsciption ID. Can receive the current quantity, autorenewal status, creation date, and more." }, { "info": { "name": "Update Subscription Auto-Renewal", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v3/customers/:customer-id/subscriptions/:subscription-id", "params": [ { "name": "customer-id", "value": "", "type": "path", "description": "customer-id" }, { "name": "subscription-id", "value": "", "type": "path", "description": "subscription-id" } ] }, "docs": "Update the auto renewal status and quantity of licenses to renew. Subscriptions that are created by an order will be set to auto-renew by default." } ] }, { "info": { "name": "Transfers", "type": "folder" }, "items": [ { "info": { "name": "Preview Offers for Transfer for a Membership ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/memberships/:membership-id/offers", "params": [ { "name": "ignore-order-return", "value": "", "type": "query", "description": "ignore-order-return" }, { "name": "membership-id", "value": "", "type": "path", "description": "membership-id" } ] }, "docs": "Preview Offers for Transfer for a Membership ID" }, { "info": { "name": "Transfer Subscriptions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/memberships/:membership-id/transfers", "params": [ { "name": "ignore-order-return", "value": "", "type": "query", "description": "ignore-order-return" }, { "name": "membership-id", "value": "", "type": "path", "description": "membership-id" } ] }, "docs": "Transfer Subscriptions" }, { "info": { "name": "Get Transfer details for a Membership ID and Transfer ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/memberships/:membership-id/transfers/:transfer-id", "params": [ { "name": "membership-id", "value": "", "type": "path", "description": "membership-id" }, { "name": "transfer-id", "value": "", "type": "path", "description": "transfer-id" } ] }, "docs": "Get Transfer details for a Membership ID and Transfer ID" }, { "info": { "name": "Preview Offers for Transfer for a Membership ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/memberships/:membership-id/offers", "params": [ { "name": "ignore-order-return", "value": "", "type": "query", "description": "ignore-order-return" }, { "name": "membership-id", "value": "", "type": "path", "description": "membership-id" } ] }, "docs": "Preview Offers for Transfer for a Membership ID" }, { "info": { "name": "Transfer Subscriptions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/memberships/:membership-id/transfers", "params": [ { "name": "ignore-order-return", "value": "", "type": "query", "description": "ignore-order-return" }, { "name": "membership-id", "value": "", "type": "path", "description": "membership-id" } ] }, "docs": "Transfer Subscriptions" }, { "info": { "name": "Get Transfer details for a Membership ID and Transfer ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/memberships/:membership-id/transfers/:transfer-id", "params": [ { "name": "membership-id", "value": "", "type": "path", "description": "membership-id" }, { "name": "transfer-id", "value": "", "type": "path", "description": "transfer-id" } ] }, "docs": "Get Transfer details for a Membership ID and Transfer ID" } ] }, { "info": { "name": "Resellers", "type": "folder" }, "items": [ { "info": { "name": "Create Reseller Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/resellers" }, "docs": "Upon joining marketplace, if a Reseller accepts T&C, marketplace creates an account for reseller with Create Reseller Account.The reseller account will be assigned to a specified Distributor ID and be able to specify company profile, contacts, and more." }, { "info": { "name": "Get Reseller Change Preview", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/resellers/:account-id/accept/:approval-code", "params": [ { "name": "account-id", "value": "", "type": "path", "description": "account-id" }, { "name": "approval-code", "value": "", "type": "path", "description": "approval-code" } ] }, "docs": "Checks approval code, returns subscriptions" }, { "info": { "name": "Execute Reseller Change", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/resellers/:account-id/accept/:approval-code", "params": [ { "name": "account-id", "value": "", "type": "path", "description": "account-id" }, { "name": "approval-code", "value": "", "type": "path", "description": "approval-code" } ] }, "docs": "Applies reseller change" }, { "info": { "name": "Get Reseller Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/resellers/:reseller-id", "params": [ { "name": "reseller-id", "value": "", "type": "path", "description": "reseller-id" } ] }, "docs": "Gets Reseller Account corresponding to the matching Account ID. This will include account info such as distributor/reseller ID, company profile information, and more." }, { "info": { "name": "Update Reseller Account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/resellers/:reseller-id", "params": [ { "name": "reseller-id", "value": "", "type": "path", "description": "reseller-id" } ] }, "docs": "Update Reseller Account information. Personal details such as address, city, phone number, etc. can be updated. Administrative details such as contacts, company name, and more can be updated as well." }, { "info": { "name": "Create Reseller Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/resellers" }, "docs": "Upon joining marketplace, if a Reseller accepts T&C, marketplace creates an account for reseller with Create Reseller Account.The reseller account will be assigned to a specified Distributor ID and be able to specify company profile, contacts, and more." }, { "info": { "name": "Get Reseller Change Preview", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/resellers/:account-id/accept/:approval-code", "params": [ { "name": "account-id", "value": "", "type": "path", "description": "account-id" }, { "name": "approval-code", "value": "", "type": "path", "description": "approval-code" } ] }, "docs": "Checks approval code, returns subscriptions" }, { "info": { "name": "Execute Reseller Change", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/resellers/:account-id/accept/:approval-code", "params": [ { "name": "account-id", "value": "", "type": "path", "description": "account-id" }, { "name": "approval-code", "value": "", "type": "path", "description": "approval-code" } ] }, "docs": "Applies reseller change" }, { "info": { "name": "Get Reseller Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/resellers/:reseller-id", "params": [ { "name": "reseller-id", "value": "", "type": "path", "description": "reseller-id" } ] }, "docs": "Gets Reseller Account corresponding to the matching Account ID. This will include account info such as distributor/reseller ID, company profile information, and more." }, { "info": { "name": "Update Reseller Account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v3/resellers/:reseller-id", "params": [ { "name": "reseller-id", "value": "", "type": "path", "description": "reseller-id" } ] }, "docs": "Update Reseller Account information. Personal details such as address, city, phone number, etc. can be updated. Administrative details such as contacts, company name, and more can be updated as well." } ] } ], "bundled": true }