Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Jetti

Topics

  • Introduction
  • Authentication

Endpoints

  • accounting-integration
    • POST /accounting-integrations.json POST
    • GET /accounting-integrations/{id}.json GET
    • PUT /accounting-integrations/{id}.json PUT
    • DELETE /accounting-integrations/{id}.json DELETE
  • accounting-payload
    • POST /accounting-payloads.json POST
    • GET /accounting-payloads/{id}.json GET
    • PUT /accounting-payloads/{id}.json PUT
    • DELETE /accounting-payloads/{id}.json DELETE
  • address-validation
    • POST /address-validations.json POST
    • GET /address-validations/{id}.json GET
    • PUT /address-validations/{id}.json PUT
    • DELETE /address-validations/{id}.json DELETE
  • adjustment
    • POST /adjustments.json POST
    • GET /adjustments/{id}.json GET
    • PUT /adjustments/{id}.json PUT
    • DELETE /adjustments/{id}.json DELETE
  • adjustment-reason
    • POST /adjustment-reasons.json POST
    • GET /adjustment-reasons/{id}.json GET
    • PUT /adjustment-reasons/{id}.json PUT
    • DELETE /adjustment-reasons/{id}.json DELETE
  • agreement
    • POST /agreements.json POST
    • GET /agreements/{id}.json GET
    • PUT /agreements/{id}.json PUT
    • DELETE /agreements/{id}.json DELETE
  • allowed-tag
    • POST /allowed-tags.json POST
    • GET /allowed-tags/{id}.json GET
    • PUT /allowed-tags/{id}.json PUT
    • DELETE /allowed-tags/{id}.json DELETE
  • amazon-account
    • POST /amazon-accounts.json POST
    • GET /amazon-accounts/{id}.json GET
    • PUT /amazon-accounts/{id}.json PUT
    • DELETE /amazon-accounts/{id}.json DELETE
  • amazon-account-report
    • POST /amazon-account-reports.json POST
    • GET /amazon-account-reports/{id}.json GET
    • PUT /amazon-account-reports/{id}.json PUT
    • DELETE /amazon-account-reports/{id}.json DELETE
  • big-commerce-store
    • POST /big-commerce-stores.json POST
    • GET /big-commerce-stores/{id}.json GET
    • PUT /big-commerce-stores/{id}.json PUT
    • DELETE /big-commerce-stores/{id}.json DELETE
  • bundle-variant
    • POST /bundle-variants.json POST
    • GET /bundle-variants/{id}.json GET
    • PUT /bundle-variants/{id}.json PUT
    • DELETE /bundle-variants/{id}.json DELETE
  • carrier
    • POST /carriers.json POST
    • GET /carriers/{id}.json GET
    • PUT /carriers/{id}.json PUT
    • DELETE /carriers/{id}.json DELETE
  • carrier-pickup
    • POST /carrier-pickups.json POST
    • GET /carrier-pickups/{id}.json GET
    • PUT /carrier-pickups/{id}.json PUT
    • DELETE /carrier-pickups/{id}.json DELETE
  • channel
    • POST /channels.json POST
    • GET /channels/{id}.json GET
    • PUT /channels/{id}.json PUT
    • DELETE /channels/{id}.json DELETE
    • POST /channels/{id}/rates.json POST
    • POST /channels/{id}/manual-sale.json POST
    • POST /channels/{id}/import-connector-variant-batch.json POST
    • PUT /channels/{id}/acknowledge-variant.json PUT
    • GET /channels/{id}/variant-levels.json GET
    • PUT /channels/{id}/variant-set-level.json PUT
  • channel-commission-rate
    • POST /channel-commission-rates.json POST
    • GET /channel-commission-rates/{id}.json GET
    • PUT /channel-commission-rates/{id}.json PUT
    • DELETE /channel-commission-rates/{id}.json DELETE
  • channel-custom-field
    • POST /channel-custom-fields.json POST
    • GET /channel-custom-fields/{id}.json GET
    • PUT /channel-custom-fields/{id}.json PUT
    • DELETE /channel-custom-fields/{id}.json DELETE
  • channel-dropship-location
    • POST /channel-dropship-locations.json POST
    • GET /channel-dropship-locations/{id}.json GET
    • PUT /channel-dropship-locations/{id}.json PUT
    • DELETE /channel-dropship-locations/{id}.json DELETE
  • channel-dropship-provider-tax-rate
    • POST /channel-dropship-provider-tax-rates.json POST
    • GET /channel-dropship-provider-tax-rates/{id}.json GET
    • PUT /channel-dropship-provider-tax-rates/{id}.json PUT
    • DELETE /channel-dropship-provider-tax-rates/{id}.json DELETE
  • channel-price-list
    • POST /channel-price-lists.json POST
    • GET /channel-price-lists/{id}.json GET
    • PUT /channel-price-lists/{id}.json PUT
    • DELETE /channel-price-lists/{id}.json DELETE
  • channel-product
    • POST /channel-products.json POST
    • GET /channel-products/{id}.json GET
    • PUT /channel-products/{id}.json PUT
    • DELETE /channel-products/{id}.json DELETE
  • channel-shipment-update
    • POST /channel-shipment-updates.json POST
    • GET /channel-shipment-updates/{id}.json GET
    • PUT /channel-shipment-updates/{id}.json PUT
    • DELETE /channel-shipment-updates/{id}.json DELETE
  • channel-shipping-rate
    • POST /channel-shipping-rates.json POST
    • GET /channel-shipping-rates/{id}.json GET
    • PUT /channel-shipping-rates/{id}.json PUT
    • DELETE /channel-shipping-rates/{id}.json DELETE
  • channel-site
    • POST /channel-sites.json POST
    • GET /channel-sites/{id}.json GET
    • PUT /channel-sites/{id}.json PUT
    • DELETE /channel-sites/{id}.json DELETE
  • channel-variant
    • POST /channel-variants.json POST
    • GET /channel-variants/{id}.json GET
    • PUT /channel-variants/{id}.json PUT
    • DELETE /channel-variants/{id}.json DELETE
  • channel-variant-import
    • POST /channel-variant-imports.json POST
    • GET /channel-variant-imports/{id}.json GET
    • PUT /channel-variant-imports/{id}.json PUT
    • DELETE /channel-variant-imports/{id}.json DELETE
  • channel-variant-update
    • POST /channel-variant-updates.json POST
    • GET /channel-variant-updates/{id}.json GET
    • PUT /channel-variant-updates/{id}.json PUT
    • DELETE /channel-variant-updates/{id}.json DELETE
  • comment
    • POST /comments.json POST
    • GET /comments/{id}.json GET
    • PUT /comments/{id}.json PUT
    • DELETE /comments/{id}.json DELETE
  • company-client
    • POST /company-clients.json POST
    • GET /company-clients/{id}.json GET
    • PUT /company-clients/{id}.json PUT
    • DELETE /company-clients/{id}.json DELETE
  • company-referral
    • POST /company-referrals.json POST
    • GET /company-referrals/{id}.json GET
    • PUT /company-referrals/{id}.json PUT
    • DELETE /company-referrals/{id}.json DELETE
  • company-setting
    • POST /company-settings.json POST
    • GET /company-settings/{id}.json GET
    • PUT /company-settings/{id}.json PUT
    • DELETE /company-settings/{id}.json DELETE
  • currency
    • POST /currencies.json POST
    • GET /currencies/{id}.json GET
    • PUT /currencies/{id}.json PUT
    • DELETE /currencies/{id}.json DELETE
  • custom-channel
    • POST /custom-channels.json POST
    • GET /custom-channels/{id}.json GET
    • PUT /custom-channels/{id}.json PUT
    • DELETE /custom-channels/{id}.json DELETE
  • custom-field
    • POST /custom-fields.json POST
    • GET /custom-fields/{id}.json GET
    • PUT /custom-fields/{id}.json PUT
    • DELETE /custom-fields/{id}.json DELETE
  • custom-field-dropship-provider
    • POST /custom-field-dropship-providers.json POST
    • GET /custom-field-dropship-providers/{id}.json GET
    • PUT /custom-field-dropship-providers/{id}.json PUT
    • DELETE /custom-field-dropship-providers/{id}.json DELETE
  • custom-field-dropshipment
    • POST /custom-field-dropshipments.json POST
    • GET /custom-field-dropshipments/{id}.json GET
    • PUT /custom-field-dropshipments/{id}.json PUT
    • DELETE /custom-field-dropshipments/{id}.json DELETE
  • custom-field-dropshipment-item
    • POST /custom-field-dropshipment-items.json POST
    • GET /custom-field-dropshipment-items/{id}.json GET
    • PUT /custom-field-dropshipment-items/{id}.json PUT
    • DELETE /custom-field-dropshipment-items/{id}.json DELETE
  • custom-field-purchase
    • POST /custom-field-purchases.json POST
    • GET /custom-field-purchases/{id}.json GET
    • PUT /custom-field-purchases/{id}.json PUT
    • DELETE /custom-field-purchases/{id}.json DELETE
  • custom-field-purchase-item
    • POST /custom-field-purchase-items.json POST
    • GET /custom-field-purchase-items/{id}.json GET
    • PUT /custom-field-purchase-items/{id}.json PUT
    • DELETE /custom-field-purchase-items/{id}.json DELETE
  • custom-field-reseller
    • POST /custom-field-resellers.json POST
    • GET /custom-field-resellers/{id}.json GET
    • PUT /custom-field-resellers/{id}.json PUT
    • DELETE /custom-field-resellers/{id}.json DELETE
  • custom-field-sale
    • POST /custom-field-sales.json POST
    • GET /custom-field-sales/{id}.json GET
    • PUT /custom-field-sales/{id}.json PUT
    • DELETE /custom-field-sales/{id}.json DELETE
  • custom-field-sale-item
    • POST /custom-field-sale-items.json POST
    • GET /custom-field-sale-items/{id}.json GET
    • PUT /custom-field-sale-items/{id}.json PUT
    • DELETE /custom-field-sale-items/{id}.json DELETE
  • custom-field-sale-return
    • POST /custom-field-sale-returns.json POST
    • GET /custom-field-sale-returns/{id}.json GET
    • PUT /custom-field-sale-returns/{id}.json PUT
    • DELETE /custom-field-sale-returns/{id}.json DELETE
  • custom-field-sale-return-item
    • POST /custom-field-sale-return-items.json POST
    • GET /custom-field-sale-return-items/{id}.json GET
    • PUT /custom-field-sale-return-items/{id}.json PUT
    • DELETE /custom-field-sale-return-items/{id}.json DELETE
  • custom-field-scope
    • POST /custom-field-scopes.json POST
    • GET /custom-field-scopes/{id}.json GET
    • PUT /custom-field-scopes/{id}.json PUT
    • DELETE /custom-field-scopes/{id}.json DELETE
  • custom-field-variant
    • POST /custom-field-variants.json POST
    • GET /custom-field-variants/{id}.json GET
    • PUT /custom-field-variants/{id}.json PUT
    • DELETE /custom-field-variants/{id}.json DELETE
  • custom-field-vendor
    • POST /custom-field-vendors.json POST
    • GET /custom-field-vendors/{id}.json GET
    • PUT /custom-field-vendors/{id}.json PUT
    • DELETE /custom-field-vendors/{id}.json DELETE
  • customer
    • POST /customers.json POST
    • GET /customers/{id}.json GET
    • PUT /customers/{id}.json PUT
    • DELETE /customers/{id}.json DELETE
  • customer-address
    • POST /customer-addresses.json POST
    • GET /customer-addresses/{id}.json GET
    • PUT /customer-addresses/{id}.json PUT
    • DELETE /customer-addresses/{id}.json DELETE
  • data-export
    • POST /data-exports.json POST
    • GET /data-exports/{id}.json GET
    • PUT /data-exports/{id}.json PUT
    • DELETE /data-exports/{id}.json DELETE
  • data-import
    • POST /data-imports.json POST
    • GET /data-imports/{id}.json GET
    • PUT /data-imports/{id}.json PUT
    • DELETE /data-imports/{id}.json DELETE
  • dropship-location
    • POST /dropship-locations.json POST
    • GET /dropship-locations/{id}.json GET
    • PUT /dropship-locations/{id}.json PUT
    • DELETE /dropship-locations/{id}.json DELETE
  • dropship-provider
    • POST /dropship-providers.json POST
    • GET /dropship-providers/{id}.json GET
    • PUT /dropship-providers/{id}.json PUT
    • DELETE /dropship-providers/{id}.json DELETE
    • POST /dropship-providers/{id}/settle-invoices.json POST
  • dropship-provider-address
    • POST /dropship-provider-addresses.json POST
    • GET /dropship-provider-addresses/{id}.json GET
    • PUT /dropship-provider-addresses/{id}.json PUT
    • DELETE /dropship-provider-addresses/{id}.json DELETE
  • dropship-provider-agreement
    • POST /dropship-provider-agreements.json POST
    • GET /dropship-provider-agreements/{id}.json GET
    • PUT /dropship-provider-agreements/{id}.json PUT
    • DELETE /dropship-provider-agreements/{id}.json DELETE
  • dropship-provider-collection
    • POST /dropship-provider-collections.json POST
    • GET /dropship-provider-collections/{id}.json GET
    • PUT /dropship-provider-collections/{id}.json PUT
    • DELETE /dropship-provider-collections/{id}.json DELETE
  • dropship-provider-collection-payload
    • POST /dropship-provider-collection-payloads.json POST
    • GET /dropship-provider-collection-payloads/{id}.json GET
    • PUT /dropship-provider-collection-payloads/{id}.json PUT
    • DELETE /dropship-provider-collection-payloads/{id}.json DELETE
  • dropship-provider-inventory-feed-variant
    • POST /dropship-provider-inventory-feed-variants.json POST
    • GET /dropship-provider-inventory-feed-variants/{id}.json GET
    • PUT /dropship-provider-inventory-feed-variants/{id}.json PUT
    • DELETE /dropship-provider-inventory-feed-variants/{id}.json DELETE
  • dropship-provider-platform-action
    • POST /dropship-provider-platform-actions.json POST
    • GET /dropship-provider-platform-actions/{id}.json GET
    • PUT /dropship-provider-platform-actions/{id}.json PUT
    • DELETE /dropship-provider-platform-actions/{id}.json DELETE
  • dropship-provider-shipment-import
    • POST /dropship-provider-shipment-imports.json POST
    • GET /dropship-provider-shipment-imports/{id}.json GET
    • PUT /dropship-provider-shipment-imports/{id}.json PUT
    • DELETE /dropship-provider-shipment-imports/{id}.json DELETE
  • dropship-provider-shipping-field
    • POST /dropship-provider-shipping-fields.json POST
    • GET /dropship-provider-shipping-fields/{id}.json GET
    • PUT /dropship-provider-shipping-fields/{id}.json PUT
    • DELETE /dropship-provider-shipping-fields/{id}.json DELETE
  • dropship-provider-warehouse
    • POST /dropship-provider-warehouses.json POST
    • GET /dropship-provider-warehouses/{id}.json GET
    • PUT /dropship-provider-warehouses/{id}.json PUT
    • DELETE /dropship-provider-warehouses/{id}.json DELETE
  • dropship-purchase-import
    • POST /dropship-purchase-imports.json POST
    • GET /dropship-purchase-imports/{id}.json GET
    • PUT /dropship-purchase-imports/{id}.json PUT
    • DELETE /dropship-purchase-imports/{id}.json DELETE
  • dropshipment
    • POST /dropshipments.json POST
    • GET /dropshipments/{id}.json GET
    • PUT /dropshipments/{id}.json PUT
    • DELETE /dropshipments/{id}.json DELETE
    • GET /dropshipments/{id}/regenerate-label.json GET
    • PUT /dropshipments/{id}/move-to-fulfill.json PUT
  • dropshipment-import
    • POST /dropshipment-imports.json POST
    • GET /dropshipment-imports/{id}.json GET
    • PUT /dropshipment-imports/{id}.json PUT
    • DELETE /dropshipment-imports/{id}.json DELETE
  • dropshipment-item
    • POST /dropshipment-items.json POST
    • GET /dropshipment-items/{id}.json GET
    • PUT /dropshipment-items/{id}.json PUT
    • DELETE /dropshipment-items/{id}.json DELETE
  • duoplane-account
    • POST /duoplane-accounts.json POST
    • GET /duoplane-accounts/{id}.json GET
    • PUT /duoplane-accounts/{id}.json PUT
    • DELETE /duoplane-accounts/{id}.json DELETE
  • elastic-path-store
    • POST /elastic-path-stores.json POST
    • GET /elastic-path-stores/{id}.json GET
    • PUT /elastic-path-stores/{id}.json PUT
    • DELETE /elastic-path-stores/{id}.json DELETE
  • error
    • POST /errors.json POST
    • GET /errors/{id}.json GET
    • PUT /errors/{id}.json PUT
    • DELETE /errors/{id}.json DELETE
  • fulfillment
    • POST /fulfillments.json POST
    • GET /fulfillments/{id}.json GET
    • PUT /fulfillments/{id}.json PUT
    • DELETE /fulfillments/{id}.json DELETE
    • PUT /fulfillments/{id}/move-to-dropship.json PUT
  • fulfillment-item
    • POST /fulfillment-items.json POST
    • GET /fulfillment-items/{id}.json GET
    • PUT /fulfillment-items/{id}.json PUT
    • DELETE /fulfillment-items/{id}.json DELETE
  • goods-receipt
    • POST /goods-receipts.json POST
    • GET /goods-receipts/{id}.json GET
    • PUT /goods-receipts/{id}.json PUT
    • DELETE /goods-receipts/{id}.json DELETE
  • goods-receipt-item
    • POST /goods-receipt-items.json POST
    • GET /goods-receipt-items/{id}.json GET
    • PUT /goods-receipt-items/{id}.json PUT
    • DELETE /goods-receipt-items/{id}.json DELETE
  • importer
    • POST /importers.json POST
    • GET /importers/{id}.json GET
    • PUT /importers/{id}.json PUT
    • DELETE /importers/{id}.json DELETE
  • inventory-export
    • POST /inventory-exports.json POST
    • GET /inventory-exports/{id}.json GET
    • PUT /inventory-exports/{id}.json PUT
    • DELETE /inventory-exports/{id}.json DELETE
    • GET /inventory-exports/{id}/export.json GET
  • inventory-export-field
    • POST /inventory-export-fields.json POST
    • GET /inventory-export-fields/{id}.json GET
    • PUT /inventory-export-fields/{id}.json PUT
    • DELETE /inventory-export-fields/{id}.json DELETE
  • inventory-feed
    • POST /inventory-feeds.json POST
    • GET /inventory-feeds/{id}.json GET
    • PUT /inventory-feeds/{id}.json PUT
    • DELETE /inventory-feeds/{id}.json DELETE
    • PUT /inventory-feeds/{id}/publish-all.json PUT
    • DELETE /inventory-feeds/{id}/remove-by-external-id.json DELETE
  • inventory-feed-channel
    • POST /inventory-feed-channels.json POST
    • GET /inventory-feed-channels/{id}.json GET
    • PUT /inventory-feed-channels/{id}.json PUT
    • DELETE /inventory-feed-channels/{id}.json DELETE
  • inventory-feed-field
    • POST /inventory-feed-fields.json POST
    • GET /inventory-feed-fields/{id}.json GET
    • PUT /inventory-feed-fields/{id}.json PUT
    • DELETE /inventory-feed-fields/{id}.json DELETE
  • inventory-feed-file
    • POST /inventory-feed-files.json POST
    • GET /inventory-feed-files/{id}.json GET
    • PUT /inventory-feed-files/{id}.json PUT
    • DELETE /inventory-feed-files/{id}.json DELETE
  • inventory-feed-json-field
    • POST /inventory-feed-json-fields.json POST
    • GET /inventory-feed-json-fields/{id}.json GET
    • PUT /inventory-feed-json-fields/{id}.json PUT
    • DELETE /inventory-feed-json-fields/{id}.json DELETE
  • inventory-feed-mapping
    • POST /inventory-feed-mappings.json POST
    • GET /inventory-feed-mappings/{id}.json GET
    • PUT /inventory-feed-mappings/{id}.json PUT
    • DELETE /inventory-feed-mappings/{id}.json DELETE
  • inventory-feed-parameter
    • POST /inventory-feed-parameters.json POST
    • GET /inventory-feed-parameters/{id}.json GET
    • PUT /inventory-feed-parameters/{id}.json PUT
    • DELETE /inventory-feed-parameters/{id}.json DELETE
  • inventory-feed-payload
    • POST /inventory-feed-payloads.json POST
    • GET /inventory-feed-payloads/{id}.json GET
    • PUT /inventory-feed-payloads/{id}.json PUT
    • DELETE /inventory-feed-payloads/{id}.json DELETE
  • inventory-feed-price-list
    • POST /inventory-feed-price-lists.json POST
    • GET /inventory-feed-price-lists/{id}.json GET
    • PUT /inventory-feed-price-lists/{id}.json PUT
    • DELETE /inventory-feed-price-lists/{id}.json DELETE
  • inventory-feed-product
    • POST /inventory-feed-products.json POST
    • GET /inventory-feed-products/{id}.json GET
    • PUT /inventory-feed-products/{id}.json PUT
    • DELETE /inventory-feed-products/{id}.json DELETE
  • inventory-feed-variant
    • POST /inventory-feed-variants.json POST
    • GET /inventory-feed-variants/{id}.json GET
    • PUT /inventory-feed-variants/{id}.json PUT
    • DELETE /inventory-feed-variants/{id}.json DELETE
    • POST /inventory-feed-variants/{id}/publish.json POST
  • inventory-feed-variant-connection
    • POST /inventory-feed-variant-connections.json POST
    • GET /inventory-feed-variant-connections/{id}.json GET
    • PUT /inventory-feed-variant-connections/{id}.json PUT
    • DELETE /inventory-feed-variant-connections/{id}.json DELETE
  • inventory-import
    • POST /inventory-imports.json POST
    • GET /inventory-imports/{id}.json GET
    • PUT /inventory-imports/{id}.json PUT
    • DELETE /inventory-imports/{id}.json DELETE
  • inventory-import-field
    • POST /inventory-import-fields.json POST
    • GET /inventory-import-fields/{id}.json GET
    • PUT /inventory-import-fields/{id}.json PUT
    • DELETE /inventory-import-fields/{id}.json DELETE
  • inventory-transfer
    • POST /inventory-transfers.json POST
    • GET /inventory-transfers/{id}.json GET
    • PUT /inventory-transfers/{id}.json PUT
    • DELETE /inventory-transfers/{id}.json DELETE
  • inventory-transfer-item
    • POST /inventory-transfer-items.json POST
    • GET /inventory-transfer-items/{id}.json GET
    • PUT /inventory-transfer-items/{id}.json PUT
    • DELETE /inventory-transfer-items/{id}.json DELETE
  • label-payload
    • POST /label-payloads.json POST
    • GET /label-payloads/{id}.json GET
    • PUT /label-payloads/{id}.json PUT
    • DELETE /label-payloads/{id}.json DELETE
  • landed-cost
    • POST /landed-costs.json POST
    • GET /landed-costs/{id}.json GET
    • PUT /landed-costs/{id}.json PUT
    • DELETE /landed-costs/{id}.json DELETE
  • landed-cost-dropship-provider
    • POST /landed-cost-dropship-providers.json POST
    • GET /landed-cost-dropship-providers/{id}.json GET
    • PUT /landed-cost-dropship-providers/{id}.json PUT
    • DELETE /landed-cost-dropship-providers/{id}.json DELETE
  • landed-cost-purchase-invoice
    • POST /landed-cost-purchase-invoices.json POST
    • GET /landed-cost-purchase-invoices/{id}.json GET
    • PUT /landed-cost-purchase-invoices/{id}.json PUT
    • DELETE /landed-cost-purchase-invoices/{id}.json DELETE
  • landed-cost-purchase-invoice-item
    • POST /landed-cost-purchase-invoice-items.json POST
    • GET /landed-cost-purchase-invoice-items/{id}.json GET
    • PUT /landed-cost-purchase-invoice-items/{id}.json PUT
    • DELETE /landed-cost-purchase-invoice-items/{id}.json DELETE
  • magento-store
    • POST /magento-stores.json POST
    • GET /magento-stores/{id}.json GET
    • PUT /magento-stores/{id}.json PUT
    • DELETE /magento-stores/{id}.json DELETE
  • manifest
    • POST /manifests.json POST
    • GET /manifests/{id}.json GET
    • PUT /manifests/{id}.json PUT
    • DELETE /manifests/{id}.json DELETE
  • note
    • POST /notes.json POST
    • GET /notes/{id}.json GET
    • PUT /notes/{id}.json PUT
    • DELETE /notes/{id}.json DELETE
  • option
    • POST /options.json POST
    • GET /options/{id}.json GET
    • PUT /options/{id}.json PUT
    • DELETE /options/{id}.json DELETE
  • option-value
    • POST /option-values.json POST
    • GET /option-values/{id}.json GET
    • PUT /option-values/{id}.json PUT
    • DELETE /option-values/{id}.json DELETE
  • payment-method
    • POST /payment-methods.json POST
    • GET /payment-methods/{id}.json GET
    • PUT /payment-methods/{id}.json PUT
    • DELETE /payment-methods/{id}.json DELETE
  • platform-shipping-mapping
    • POST /platform-shipping-mappings.json POST
    • GET /platform-shipping-mappings/{id}.json GET
    • PUT /platform-shipping-mappings/{id}.json PUT
    • DELETE /platform-shipping-mappings/{id}.json DELETE
  • portal-link
    • POST /portal-links.json POST
    • GET /portal-links/{id}.json GET
    • PUT /portal-links/{id}.json PUT
    • DELETE /portal-links/{id}.json DELETE
  • price
    • POST /prices.json POST
    • GET /prices/{id}.json GET
    • PUT /prices/{id}.json PUT
    • DELETE /prices/{id}.json DELETE
  • price-list
    • POST /price-lists.json POST
    • GET /price-lists/{id}.json GET
    • PUT /price-lists/{id}.json PUT
    • DELETE /price-lists/{id}.json DELETE
  • price-list-import
    • POST /price-list-imports.json POST
    • GET /price-list-imports/{id}.json GET
    • PUT /price-list-imports/{id}.json PUT
    • DELETE /price-list-imports/{id}.json DELETE
  • price-list-variant
    • POST /price-list-variants.json POST
    • GET /price-list-variants/{id}.json GET
    • PUT /price-list-variants/{id}.json PUT
    • DELETE /price-list-variants/{id}.json DELETE
  • price-update
    • POST /price-updates.json POST
    • GET /price-updates/{id}.json GET
    • PUT /price-updates/{id}.json PUT
    • DELETE /price-updates/{id}.json DELETE
  • product
    • POST /products.json POST
    • GET /products/{id}.json GET
    • PUT /products/{id}.json PUT
    • DELETE /products/{id}.json DELETE
  • purchase
    • POST /purchases.json POST
    • GET /purchases/{id}.json GET
    • PUT /purchases/{id}.json PUT
    • DELETE /purchases/{id}.json DELETE
    • POST /purchases/{id}/ship.json POST
    • PUT /purchases/{id}/move-dropship-provider.json PUT
    • PUT /purchases/{id}/send.json PUT
    • POST /purchases/{id}/return-label.json POST
    • PUT /purchases/{id}/default-label.json PUT
    • PUT /purchases/{id}/cancel.json PUT
  • purchase-invoice
    • POST /purchase-invoices.json POST
    • GET /purchase-invoices/{id}.json GET
    • PUT /purchase-invoices/{id}.json PUT
    • DELETE /purchase-invoices/{id}.json DELETE
  • purchase-invoice-item
    • POST /purchase-invoice-items.json POST
    • GET /purchase-invoice-items/{id}.json GET
    • PUT /purchase-invoice-items/{id}.json PUT
    • DELETE /purchase-invoice-items/{id}.json DELETE
  • purchase-invoice-payment
    • POST /purchase-invoice-payments.json POST
    • GET /purchase-invoice-payments/{id}.json GET
    • PUT /purchase-invoice-payments/{id}.json PUT
    • DELETE /purchase-invoice-payments/{id}.json DELETE
  • purchase-item
    • POST /purchase-items.json POST
    • GET /purchase-items/{id}.json GET
    • PUT /purchase-items/{id}.json PUT
    • DELETE /purchase-items/{id}.json DELETE
  • purchase-notification
    • POST /purchase-notifications.json POST
    • GET /purchase-notifications/{id}.json GET
    • PUT /purchase-notifications/{id}.json PUT
    • DELETE /purchase-notifications/{id}.json DELETE
  • purchase-return
    • POST /purchase-returns.json POST
    • GET /purchase-returns/{id}.json GET
    • PUT /purchase-returns/{id}.json PUT
    • DELETE /purchase-returns/{id}.json DELETE
  • purchase-return-item
    • POST /purchase-return-items.json POST
    • GET /purchase-return-items/{id}.json GET
    • PUT /purchase-return-items/{id}.json PUT
    • DELETE /purchase-return-items/{id}.json DELETE
  • purchase-return-payment
    • POST /purchase-return-payments.json POST
    • GET /purchase-return-payments/{id}.json GET
    • PUT /purchase-return-payments/{id}.json PUT
    • DELETE /purchase-return-payments/{id}.json DELETE
  • purchase-shipping-rate
    • POST /purchase-shipping-rates.json POST
    • GET /purchase-shipping-rates/{id}.json GET
    • PUT /purchase-shipping-rates/{id}.json PUT
    • DELETE /purchase-shipping-rates/{id}.json DELETE
  • purchase-status
    • POST /purchase-statuses.json POST
    • GET /purchase-statuses/{id}.json GET
    • PUT /purchase-statuses/{id}.json PUT
    • DELETE /purchase-statuses/{id}.json DELETE
  • referral
    • POST /referrals.json POST
    • GET /referrals/{id}.json GET
    • PUT /referrals/{id}.json PUT
    • DELETE /referrals/{id}.json DELETE
  • reseller
    • POST /resellers.json POST
    • GET /resellers/{id}.json GET
    • PUT /resellers/{id}.json PUT
    • DELETE /resellers/{id}.json DELETE
  • reseller-commission
    • POST /reseller-commissions.json POST
    • GET /reseller-commissions/{id}.json GET
    • PUT /reseller-commissions/{id}.json PUT
    • DELETE /reseller-commissions/{id}.json DELETE
  • reseller-subscription
    • POST /reseller-subscriptions.json POST
    • GET /reseller-subscriptions/{id}.json GET
    • PUT /reseller-subscriptions/{id}.json PUT
    • DELETE /reseller-subscriptions/{id}.json DELETE
  • reseller-variant
    • POST /reseller-variants.json POST
    • GET /reseller-variants/{id}.json GET
    • PUT /reseller-variants/{id}.json PUT
    • DELETE /reseller-variants/{id}.json DELETE
  • return-shipment
    • POST /return-shipments.json POST
    • GET /return-shipments/{id}.json GET
    • PUT /return-shipments/{id}.json PUT
    • DELETE /return-shipments/{id}.json DELETE
  • review-reason
    • POST /review-reasons.json POST
    • GET /review-reasons/{id}.json GET
    • PUT /review-reasons/{id}.json PUT
    • DELETE /review-reasons/{id}.json DELETE
  • sale
    • POST /sales.json POST
    • GET /sales/{id}.json GET
    • PUT /sales/{id}.json PUT
    • DELETE /sales/{id}.json DELETE
    • POST /sales/{id}/post-to-channel.json POST
    • POST /sales/{id}/cancel.json POST
    • POST /sales/{id}/clone.json POST
  • sale-discount-code
    • POST /sale-discount-codes.json POST
    • GET /sale-discount-codes/{id}.json GET
    • PUT /sale-discount-codes/{id}.json PUT
    • DELETE /sale-discount-codes/{id}.json DELETE
  • sale-import
    • POST /sale-imports.json POST
    • GET /sale-imports/{id}.json GET
    • PUT /sale-imports/{id}.json PUT
    • DELETE /sale-imports/{id}.json DELETE
  • sale-invoice
    • POST /sale-invoices.json POST
    • GET /sale-invoices/{id}.json GET
    • PUT /sale-invoices/{id}.json PUT
    • DELETE /sale-invoices/{id}.json DELETE
  • sale-invoice-item
    • POST /sale-invoice-items.json POST
    • GET /sale-invoice-items/{id}.json GET
    • PUT /sale-invoice-items/{id}.json PUT
    • DELETE /sale-invoice-items/{id}.json DELETE
  • sale-invoice-payment
    • POST /sale-invoice-payments.json POST
    • GET /sale-invoice-payments/{id}.json GET
    • PUT /sale-invoice-payments/{id}.json PUT
    • DELETE /sale-invoice-payments/{id}.json DELETE
  • sale-item
    • POST /sale-items.json POST
    • GET /sale-items/{id}.json GET
    • PUT /sale-items/{id}.json PUT
    • DELETE /sale-items/{id}.json DELETE
  • sale-item-commission
    • POST /sale-item-commissions.json POST
    • GET /sale-item-commissions/{id}.json GET
    • PUT /sale-item-commissions/{id}.json PUT
    • DELETE /sale-item-commissions/{id}.json DELETE
  • sale-item-routing
    • POST /sale-item-routings.json POST
    • GET /sale-item-routings/{id}.json GET
    • PUT /sale-item-routings/{id}.json PUT
    • DELETE /sale-item-routings/{id}.json DELETE
  • sale-return
    • POST /sale-returns.json POST
    • GET /sale-returns/{id}.json GET
    • PUT /sale-returns/{id}.json PUT
    • DELETE /sale-returns/{id}.json DELETE
    • GET /sale-returns/{id}/weight.json GET
    • PUT /sale-returns/{id}/default-label.json PUT
  • sale-return-item
    • POST /sale-return-items.json POST
    • GET /sale-return-items/{id}.json GET
    • PUT /sale-return-items/{id}.json PUT
    • DELETE /sale-return-items/{id}.json DELETE
  • sale-return-payload
    • POST /sale-return-payloads.json POST
    • GET /sale-return-payloads/{id}.json GET
    • PUT /sale-return-payloads/{id}.json PUT
    • DELETE /sale-return-payloads/{id}.json DELETE
  • sale-return-payment
    • POST /sale-return-payments.json POST
    • GET /sale-return-payments/{id}.json GET
    • PUT /sale-return-payments/{id}.json PUT
    • DELETE /sale-return-payments/{id}.json DELETE
  • sale-shipping-rate
    • POST /sale-shipping-rates.json POST
    • GET /sale-shipping-rates/{id}.json GET
    • PUT /sale-shipping-rates/{id}.json PUT
    • DELETE /sale-shipping-rates/{id}.json DELETE
  • saleor-store
    • POST /saleor-stores.json POST
    • GET /saleor-stores/{id}.json GET
    • PUT /saleor-stores/{id}.json PUT
    • DELETE /saleor-stores/{id}.json DELETE
  • salesforce-account
    • POST /salesforce-accounts.json POST
    • GET /salesforce-accounts/{id}.json GET
    • PUT /salesforce-accounts/{id}.json PUT
    • DELETE /salesforce-accounts/{id}.json DELETE
  • scheduled-task
    • POST /scheduled-tasks.json POST
    • GET /scheduled-tasks/{id}.json GET
    • PUT /scheduled-tasks/{id}.json PUT
    • DELETE /scheduled-tasks/{id}.json DELETE
  • shipping-integration
    • POST /shipping-integrations.json POST
    • GET /shipping-integrations/{id}.json GET
    • PUT /shipping-integrations/{id}.json PUT
    • DELETE /shipping-integrations/{id}.json DELETE
  • shipping-rate
    • POST /shipping-rates.json POST
    • GET /shipping-rates/{id}.json GET
    • PUT /shipping-rates/{id}.json PUT
    • DELETE /shipping-rates/{id}.json DELETE
  • shipping-rate-carrier
    • POST /shipping-rate-carriers.json POST
    • GET /shipping-rate-carriers/{id}.json GET
    • PUT /shipping-rate-carriers/{id}.json PUT
    • DELETE /shipping-rate-carriers/{id}.json DELETE
  • shipping-rate-mapping
    • POST /shipping-rate-mappings.json POST
    • GET /shipping-rate-mappings/{id}.json GET
    • PUT /shipping-rate-mappings/{id}.json PUT
    • DELETE /shipping-rate-mappings/{id}.json DELETE
  • shipping-rate-product-type
    • POST /shipping-rate-product-types.json POST
    • GET /shipping-rate-product-types/{id}.json GET
    • PUT /shipping-rate-product-types/{id}.json PUT
    • DELETE /shipping-rate-product-types/{id}.json DELETE
  • shipping-rate-weight
    • POST /shipping-rate-weights.json POST
    • GET /shipping-rate-weights/{id}.json GET
    • PUT /shipping-rate-weights/{id}.json PUT
    • DELETE /shipping-rate-weights/{id}.json DELETE
  • shipping-rate-zone
    • POST /shipping-rate-zones.json POST
    • GET /shipping-rate-zones/{id}.json GET
    • PUT /shipping-rate-zones/{id}.json PUT
    • DELETE /shipping-rate-zones/{id}.json DELETE
  • shipping-rate-zone-code
    • POST /shipping-rate-zone-codes.json POST
    • GET /shipping-rate-zone-codes/{id}.json GET
    • PUT /shipping-rate-zone-codes/{id}.json PUT
    • DELETE /shipping-rate-zone-codes/{id}.json DELETE
  • shipping-rate-zone-code-band
    • POST /shipping-rate-zone-code-bands.json POST
    • GET /shipping-rate-zone-code-bands/{id}.json GET
    • PUT /shipping-rate-zone-code-bands/{id}.json PUT
    • DELETE /shipping-rate-zone-code-bands/{id}.json DELETE
  • shipping-rate-zone-variant
    • POST /shipping-rate-zone-variants.json POST
    • GET /shipping-rate-zone-variants/{id}.json GET
    • PUT /shipping-rate-zone-variants/{id}.json PUT
    • DELETE /shipping-rate-zone-variants/{id}.json DELETE
  • shopify-store
    • POST /shopify-stores.json POST
    • GET /shopify-stores/{id}.json GET
    • PUT /shopify-stores/{id}.json PUT
    • DELETE /shopify-stores/{id}.json DELETE
  • shopify-store-location
    • POST /shopify-store-locations.json POST
    • GET /shopify-store-locations/{id}.json GET
    • PUT /shopify-store-locations/{id}.json PUT
    • DELETE /shopify-store-locations/{id}.json DELETE
  • square-space-store
    • POST /square-space-stores.json POST
    • GET /square-space-stores/{id}.json GET
    • PUT /square-space-stores/{id}.json PUT
    • DELETE /square-space-stores/{id}.json DELETE
  • stock-take
    • POST /stock-takes.json POST
    • GET /stock-takes/{id}.json GET
    • PUT /stock-takes/{id}.json PUT
    • DELETE /stock-takes/{id}.json DELETE
  • stock-take-item
    • POST /stock-take-items.json POST
    • GET /stock-take-items/{id}.json GET
    • PUT /stock-take-items/{id}.json PUT
    • DELETE /stock-take-items/{id}.json DELETE
  • subscription
    • POST /subscriptions.json POST
    • GET /subscriptions/{id}.json GET
    • PUT /subscriptions/{id}.json PUT
    • DELETE /subscriptions/{id}.json DELETE
  • subscription-charge
    • POST /subscription-charges.json POST
    • GET /subscription-charges/{id}.json GET
    • PUT /subscription-charges/{id}.json PUT
    • DELETE /subscription-charges/{id}.json DELETE
  • tax-rate
    • POST /tax-rates.json POST
    • GET /tax-rates/{id}.json GET
    • PUT /tax-rates/{id}.json PUT
    • DELETE /tax-rates/{id}.json DELETE
  • template
    • POST /templates.json POST
    • GET /templates/{id}.json GET
    • PUT /templates/{id}.json PUT
    • DELETE /templates/{id}.json DELETE
  • template-mapping
    • POST /template-mappings.json POST
    • GET /template-mappings/{id}.json GET
    • PUT /template-mappings/{id}.json PUT
    • DELETE /template-mappings/{id}.json DELETE
  • tracking-event
    • POST /tracking-events.json POST
    • GET /tracking-events/{id}.json GET
    • PUT /tracking-events/{id}.json PUT
    • DELETE /tracking-events/{id}.json DELETE
  • transaction
    • POST /transactions.json POST
    • GET /transactions/{id}.json GET
    • PUT /transactions/{id}.json PUT
    • DELETE /transactions/{id}.json DELETE
    • PUT /transactions/{id}/refund.json PUT
    • PUT /transactions/{id}/update-tracking.json PUT
  • transaction-export
    • POST /transaction-exports.json POST
    • GET /transaction-exports/{id}.json GET
    • PUT /transaction-exports/{id}.json PUT
    • DELETE /transaction-exports/{id}.json DELETE
  • transfer
    • POST /transfers.json POST
    • GET /transfers/{id}.json GET
    • PUT /transfers/{id}.json PUT
    • DELETE /transfers/{id}.json DELETE
  • transfer-export
    • POST /transfer-exports.json POST
    • GET /transfer-exports/{id}.json GET
    • PUT /transfer-exports/{id}.json PUT
    • DELETE /transfer-exports/{id}.json DELETE
  • transfer-refund
    • POST /transfer-refunds.json POST
    • GET /transfer-refunds/{id}.json GET
    • PUT /transfer-refunds/{id}.json PUT
    • DELETE /transfer-refunds/{id}.json DELETE
  • user
    • POST /users.json POST
    • GET /users/{id}.json GET
    • PUT /users/{id}.json PUT
    • DELETE /users/{id}.json DELETE
    • GET /users/{id}/setting.json GET
    • POST /users/{id}/create-setting.json POST
  • user-setting
    • POST /user-settings.json POST
    • GET /user-settings/{id}.json GET
    • PUT /user-settings/{id}.json PUT
    • DELETE /user-settings/{id}.json DELETE
  • variant
    • POST /variants.json POST
    • GET /variants/{id}.json GET
    • PUT /variants/{id}.json PUT
    • DELETE /variants/{id}.json DELETE
    • PUT /variants/{id}/set-level.json PUT
    • PUT /variants/{id}/push-channel-inventory.json PUT
    • PUT /variants/{id}/push-channel-cost-price.json PUT
  • variant-hs-code
    • POST /variant-hs-codes.json POST
    • GET /variant-hs-codes/{id}.json GET
    • PUT /variant-hs-codes/{id}.json PUT
    • DELETE /variant-hs-codes/{id}.json DELETE
  • variant-inventory-update
    • POST /variant-inventory-updates.json POST
    • GET /variant-inventory-updates/{id}.json GET
    • PUT /variant-inventory-updates/{id}.json PUT
    • DELETE /variant-inventory-updates/{id}.json DELETE
  • variant-parcel
    • POST /variant-parcels.json POST
    • GET /variant-parcels/{id}.json GET
    • PUT /variant-parcels/{id}.json PUT
    • DELETE /variant-parcels/{id}.json DELETE
  • variant-warehouse
    • POST /variant-warehouses.json POST
    • GET /variant-warehouses/{id}.json GET
    • PUT /variant-warehouses/{id}.json PUT
    • DELETE /variant-warehouses/{id}.json DELETE
  • variant-warehouse-update
    • POST /variant-warehouse-updates.json POST
    • GET /variant-warehouse-updates/{id}.json GET
    • PUT /variant-warehouse-updates/{id}.json PUT
    • DELETE /variant-warehouse-updates/{id}.json DELETE
  • vendor
    • POST /vendors.json POST
    • GET /vendors/{id}.json GET
    • PUT /vendors/{id}.json PUT
    • DELETE /vendors/{id}.json DELETE
    • POST /vendors/{id}/dropship.json POST
    • POST /vendors/{id}/assign-dropship-provider.json POST
  • vendor-address
    • POST /vendor-addresses.json POST
    • GET /vendor-addresses/{id}.json GET
    • PUT /vendor-addresses/{id}.json PUT
    • DELETE /vendor-addresses/{id}.json DELETE
  • vendor-dropship-provider
    • POST /vendor-dropship-providers.json POST
    • GET /vendor-dropship-providers/{id}.json GET
    • PUT /vendor-dropship-providers/{id}.json PUT
    • DELETE /vendor-dropship-providers/{id}.json DELETE
  • warehouse
    • POST /warehouses.json POST
    • GET /warehouses/{id}.json GET
    • PUT /warehouses/{id}.json PUT
    • DELETE /warehouses/{id}.json DELETE
    • POST /warehouses/{id}/transfer.json POST
    • PUT /warehouses/{id}/import-adjustments.json PUT
    • PUT /warehouses/{id}/import-location-csv.json PUT
  • webhook
    • POST /webhooks.json POST
    • GET /webhooks/{id}.json GET
    • PUT /webhooks/{id}.json PUT
    • DELETE /webhooks/{id}.json DELETE
  • webhook-payload
    • POST /webhook-payloads.json POST
    • GET /webhook-payloads/{id}.json GET
    • PUT /webhook-payloads/{id}.json PUT
    • DELETE /webhook-payloads/{id}.json DELETE
  • woo-commerce-store
    • POST /woo-commerce-stores.json POST
    • GET /woo-commerce-stores/{id}.json GET
    • PUT /woo-commerce-stores/{id}.json PUT
    • DELETE /woo-commerce-stores/{id}.json DELETE
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Jetti

PUT /portal-links/{id}.json

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown
PUT /portal-links/{id}.json
Bearer auth

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

application/json

Body Required

  • createdAt string(date-time)

    Created at

  • icon string | null

    Icon

  • id integer(int32)

    Id

  • name string Required

    Name

  • portal string Required

    Portal

    Values are vendor, returns, or reeller.

  • updatedAt string(date-time)

    Updated at

  • url string Required

    Url

PUT /portal-links/{id}.json
curl \
 --request PUT 'http://api.example.com/v1/portal-links/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"createdAt":"2025-05-04T09:42:00Z","icon":"string","id":42,"name":"string","portal":"vendor","updatedAt":"2025-05-04T09:42:00Z","url":"string"}'
Request examples
{
  "createdAt": "2025-05-04T09:42:00Z",
  "icon": "string",
  "id": 42,
  "name": "string",
  "portal": "vendor",
  "updatedAt": "2025-05-04T09:42:00Z",
  "url": "string"
}