{ "swagger": "2.0", "info": { "title": "ShopBase Internal API", "termsOfService": "http://swagger.io/terms/", "version": "1.0.0", "contact": { "url": "/", "email": "support@shopbase.com" }, "license": { "name": "ShopBase Dev 1.0", "url": "https://www.shopbase.net" }, "x-logo": { "url": "https://admin-cdn.shopbase.com/img/Compact.ac400184.svg" } }, "host": "shop-name.onshopbase.com", "paths": { "/admin/balance/charge.json": { "post": { "summary": "Capture charge balance.", "description": "Capture charge balance.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/swagggerCaptureSuccessResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/swagggerCaptureFailureResponse" } } }, "parameters": [ { "name": "input", "description": "Charge params", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/swagggerCaptureChargeParams", "description": "Charge params" } } ], "tags": [ "Balance" ], "operationId": "charge-invoice", "produces": [ "application/json" ], "security": [ { "USER_ACCESS_TOKEN": [] } ] } }, "/admin/balance/refund.json": { "post": { "summary": "Refund balance.", "description": "Refund balance.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SuccessResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/FailureResponse" } } }, "parameters": [ { "name": "input", "description": "Refund params", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/RefundParamsDto", "description": "Refund params" } } ], "tags": [ "Balance" ], "operationId": "refund-balance", "produces": [ "application/json" ], "security": [ { "USER_ACCESS_TOKEN": [] } ] } }, "/admin/checkouts.json": { "get": { "summary": "Retrieve a list of abandoned checkouts", "description": "Retrieve a list of abandoned checkouts", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AbandonedCheckoutsSwaggerResponse" } } }, "parameters": [ { "name": "page", "description": "page query", "in": "query", "required": false, "type": "number" }, { "name": "limit", "description": "limit query", "in": "query", "required": false, "type": "number" }, { "name": "email_statuses", "description": "A comma-separated list of email statuses, supported values: scheduled,sent,not_sent", "in": "query", "required": false, "type": "string" }, { "name": "sms_statuses", "description": "A comma-separated list of sms statuses, supported values: scheduled,sent,not_sent,failed", "in": "query", "required": false, "type": "string" }, { "name": "recovery_statuses", "description": "A comma-separated list of recovery statuses, supported values: recovered,not_recovered", "in": "query", "required": false, "type": "string" }, { "name": "search", "description": "customer name, product, ...", "in": "query", "required": false, "type": "string" } ], "tags": [ "Abandoned Checkout" ], "operationId": "retrieves-a-list-of-checkouts", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/checkouts/count.json": { "get": { "summary": "Retrieve count of abandoned checkouts", "description": "Retrieve count of abandoned checkouts", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountResponse" } } }, "parameters": [ { "name": "email_statuses", "description": "A comma-separated list of email statuses, supported values: scheduled,sent,not_sent", "in": "query", "required": false, "type": "string" }, { "name": "sms_statuses", "description": "A comma-separated list of sms statuses, supported values: scheduled,sent,not_sent,failed", "in": "query", "required": false, "type": "string" }, { "name": "recovery_statuses", "description": "A comma-separated list of recovery statuses, supported values: recovered,not_recovered", "in": "query", "required": false, "type": "string" }, { "name": "search", "description": "customer name, product, ...", "in": "query", "required": false, "type": "string" } ], "tags": [ "Abandoned Checkout" ], "operationId": "count-checkouts", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/checkouts/twilio-webhook.json": { "post": { "summary": "Receive webhook from twilio", "description": "Receive webhook from twilio to update sms log, update abandoned checkout sms status, opt out sms conversation", "responses": null, "tags": [ "Abandoned Checkout" ], "operationId": "receive-webhook-from-twilio", "produces": [ "application/json" ] } }, "/admin/checkouts/{checkout_id:\\\\d+}.json": { "get": { "summary": "Retrieve a single abandoned checkout", "description": "Retrieve a single abandoned checkout", "responses": null, "parameters": [ { "name": "checkout_id", "description": "checkout id", "in": "path", "required": true, "type": "number" } ], "tags": [ "Abandoned Checkout" ], "operationId": "retrieves-a-checkout", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/cancel-send-recovery-email.json": { "post": { "summary": "Cancel scheduled email of an abandoned checkout", "description": "Cancel scheduled email of an abandoned checkout", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AbandonedCheckoutsUpdateSwaggerResponse" } } }, "parameters": [ { "name": "checkout_id", "description": "checkout id", "in": "path", "required": true, "type": "number" } ], "tags": [ "Abandoned Checkout" ], "operationId": "cancel-recovery-email", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/cancel-send-recovery-sms.json": { "post": { "summary": "Cancel scheduled sms of an abandoned checkout", "description": "Cancel scheduled sms of an abandoned checkout", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AbandonedCheckoutsUpdateSwaggerResponse" } } }, "parameters": [ { "name": "checkout_id", "description": "checkout id", "in": "path", "required": true, "type": "number" } ], "tags": [ "Abandoned Checkout" ], "operationId": "cancel-recovery-sms", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/send-recovery-email.json": { "post": { "summary": "Manually send abandoned checkout email", "description": "Manually send abandoned checkout email", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AbandonedCheckoutsUpdateSwaggerResponse" } } }, "parameters": [ { "name": "checkout_id", "description": "checkout id", "in": "path", "required": true, "type": "number" } ], "tags": [ "Abandoned Checkout" ], "operationId": "send-recovery-email", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/send-recovery-email/get-review.json": { "get": { "summary": "Retrieve an abandoned checkout email notification with preview content", "description": "Retrieve an abandoned checkout email notification with preview content", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NotificationWithSublingResponseDto" } } }, "parameters": [ { "name": "param", "description": "checkout id", "in": "path", "required": true, "type": "number" }, { "name": "category", "description": "notification category, current supported value: orders", "in": "query", "required": true, "type": "string" }, { "name": "type", "description": "notification type, current supported value: abandoned_checkout", "in": "query", "required": true, "type": "string" } ], "tags": [ "Abandoned Checkout" ], "operationId": "get-email-preview", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/send-recovery-sms.json": { "post": { "summary": "Manually send abandoned checkout sms", "description": "Manually send abandoned checkout sms", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AbandonedCheckoutsUpdateSwaggerResponse" } } }, "parameters": [ { "name": "checkout_id", "description": "checkout id", "in": "path", "required": true, "type": "number" } ], "tags": [ "Abandoned Checkout" ], "operationId": "send-recovery-sms", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/send-recovery-sms/get-review.json": { "get": { "summary": "Retrieve an abandoned checkout sms notification with preview content", "description": "Retrieve an abandoned checkout sms notification with preview content", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NotificationWithSublingResponseDto" } } }, "parameters": [ { "name": "param", "description": "checkout id", "in": "path", "required": true, "type": "number" }, { "name": "category", "description": "notification category, current supported value: orders", "in": "query", "required": true, "type": "string" }, { "name": "type", "description": "notification type, current supported value: abandoned_checkout", "in": "query", "required": true, "type": "string" } ], "tags": [ "Abandoned Checkout" ], "operationId": "get-sms-preview", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/timeline.json": { "get": { "summary": "Retrieve a list of timelines of an abandoned checkout", "description": "Retrieve a list of timelines of an abandoned checkout", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AbandonedCheckoutActivitiesSwaggerResponse" } } }, "parameters": [ { "name": "param", "description": "checkout id", "in": "path", "required": true, "type": "number" } ], "tags": [ "Abandoned Checkout" ], "operationId": "retrieves-a-list-of-checkout-timelines", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/checkouts/{checkout_id:\\\\d+}/update-note.json": { "put": { "summary": "Update abandoned checkout note", "description": "Update abandoned checkout note", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AbandonedCheckoutsUpdateSwaggerResponse" } } }, "parameters": [ { "name": "checkout_id", "description": "checkout id", "in": "path", "required": true, "type": "number" }, { "name": "input", "description": "note update request body", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/AbandonedCheckoutsNoteUpdateSwaggerRequest", "description": "note update request body" } } ], "tags": [ "Abandoned Checkout" ], "operationId": "update-checkout-note", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/collections/custom.json": { "get": { "summary": "Retrieves a list of custom collections.", "description": "Retrieve all collections.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectionListResponseSwagger" } } }, "tags": [ "Custom Collection" ], "operationId": "retrieve-a-list-of-custom-collections", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/collections/custom/count.json": { "get": { "summary": "Retrieves a count of custom collections.", "description": "Count all custom collections.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectionCountResponseSwagger" } } }, "tags": [ "Custom Collection" ], "operationId": "retrieve-a-count-of-custom-collections", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/collections/custom/{custom_collection_id:\\\\d+}.json": { "get": { "summary": "Retrieves a single custom collection.", "description": "Retrieve a specific collection by its ID.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectionByIdResponseSwagger" } } }, "tags": [ "Custom Collection" ], "operationId": "retrieve-a-single-custom-collections", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "delete": { "summary": "Deletes a custom collection.", "description": "Delete a custom collection.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteCustomCollectionResponseSwagger" } } }, "tags": [ "Custom Collection" ], "operationId": "delete-a-custom-collection", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] }, "put": { "summary": "Create or update a collection", "description": "A collection is a grouping of products that merchants can create to make their stores easier to browse.\n\nFor example, a merchant might create a collection for a specific type of product that they sell, such as Footwear.\n\nMerchants can create collections by selecting products individually or by defining rules that automatically determine whether products are included.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectionUpdateResponseSwagger" } } }, "parameters": [ { "name": "custom_collection_id", "description": "Custom collection ID", "in": "path", "required": true, "type": "integer" }, { "name": "file", "description": "Collection update request struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CollectionUpdateRequestSwagger", "description": "Collection update request struct" } } ], "tags": [ "Custom Collection" ], "operationId": "update-custom-collection", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/collects.json": { "get": { "summary": "Retrieves a list of collects.", "description": "Retrieve all collects for the shop.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectListResponseSwagger" } } }, "parameters": [ { "name": "collection_id", "description": "Filter list collect by collection", "in": "query", "required": false, "type": "integer" } ], "tags": [ "Collect" ], "operationId": "retrieve-a-list-of-collect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "post": { "summary": "Adds a product to a custom collection.", "description": "Create a new link between an existing product and an existing collection.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateCollectResponseSwagger" } } }, "parameters": [ { "name": "input", "description": "Collect request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CreateCollectRequestSwagger", "description": "Collect request" } } ], "tags": [ "Collect" ], "operationId": "create-a-collect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/collects/count.json": { "get": { "summary": "Retrieves a count of collects.", "description": "Retrieves a count of collects.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectCountResponseSwagger" } } }, "parameters": [ { "name": "collection_id", "description": "Filter list collect by collection", "in": "query", "required": false, "type": "integer" } ], "tags": [ "Collect" ], "operationId": "retrieve-a-count-of-collect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/collects/{collect_id:\\\\d+}.json": { "get": { "summary": "Retrieves a specific collect by its ID.", "description": "Retrieve a collect with a certain ID.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CollectByIdResponseSwagger" } } }, "tags": [ "Collect" ], "operationId": "retrieve-a-single-collect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "delete": { "summary": "Removes a product from a collection.", "description": "Delete the link between a product an a collection.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteCollectResponseSwagger" } } }, "parameters": [ { "name": "collect_id", "description": "Collect ID", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Collect" ], "operationId": "delete-a-collect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/customers.json": { "get": { "summary": "Retrieves a list of customers.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerForResponse" } } }, "parameters": [ { "name": "ids", "description": "Restrict results to customers specified by a comma-separated list of IDs.", "in": "query", "required": false, "type": "string" }, { "name": "since_id", "description": "Restrict results to those after the specified ID.", "in": "query", "required": false, "type": "integer" }, { "name": "created_at_min", "description": "Show customers created after a specified date. format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "created_at_max", "description": "Show customers created before a specified date. format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "updated_at_min", "description": "Show customers last updated after a specified date. format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "updated_at_max", "description": "Show customers last updated before a specified date. format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "maximum": 250, "name": "limit", "description": "The maximum number of results to show.", "in": "query", "required": false, "type": "integer", "default": 50 }, { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Customer" ], "operationId": "retrieves-a-list-of-customers", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_customers" ] } ] }, "post": { "summary": "Creates a customer.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Customer struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CustomerDto", "description": "Customer struct" } } ], "tags": [ "Customer" ], "operationId": "creates-a-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] } }, "/admin/customers/count.json": { "get": { "summary": "Retrieve a count of all customers", "description": "Retrieves a count of all customers.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountResponse" } } }, "tags": [ "Customer" ], "operationId": "retrieves-a-count-of-all-customers", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_customers" ] } ] } }, "/admin/customers/{customer_id:[0-9]+}/addresses.json": { "get": { "summary": "Retrieve all of a customer’s addresses", "description": "Retrieves a list of addresses for a customer.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerAddressesDetailResponse" } } }, "tags": [ "Customer Address" ], "operationId": "get-customer-addresses-by-customer-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_customers" ] } ] }, "post": { "summary": "Create a new address for a customer", "description": "Creates a new address for a customer.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerAddressDetailResponse" } } }, "parameters": [ { "name": "input", "description": "Customer address post form", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CustomerAddressCreateForm", "description": "Customer address post form" } } ], "tags": [ "Customer Address" ], "operationId": "create-customer-address-for-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] } }, "/admin/customers/{customer_id:[0-9]+}/addresses/set.json": { "put": { "summary": "Destroy multiple customer addresses", "description": "Performs bulk operations for multiple customer addresses.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/models.SwaggerDeleteResponse" } } }, "parameters": [ { "name": "address_ids", "description": "List of customer address.", "in": "query", "required": false, "type": "array" } ], "tags": [ "Customer Address" ], "operationId": "delete-bulk-customer-addresses-by-customer-ids", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] } }, "/admin/customers/{customer_id:[0-9]+}/addresses/{address_id:[0-9]+}.json": { "get": { "summary": "Retrieve a single customer address", "description": "Retrieves details a single customer address.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerAddressResponse" } } }, "parameters": [ { "name": "customer_id", "description": "Customer ID", "in": "path", "required": true, "type": "number" } ], "tags": [ "Customer Address" ], "operationId": "get-customer-address-by-customer-id-and-address-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_customers" ] } ] }, "delete": { "summary": "Remove a customer address", "description": "Removes an address from a customer’s address list.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/models.SwaggerDeleteResponse" } } }, "tags": [ "Customer Address" ], "operationId": "delete-customer-address-by-customer-id-and-address-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] }, "put": { "summary": "Update the postal code of a customer address", "description": "Updates an existing customer address.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerAddressResponse" } } }, "parameters": [ { "name": "input", "description": "Customer address input form", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/updateCustomerAddressForm", "description": "Customer address input form" } } ], "tags": [ "Customer Address" ], "operationId": "update-customer-address-for-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] } }, "/admin/customers/{customer_id:[0-9]+}/addresses/{address_id:[0-9]+}/default.json": { "put": { "summary": "Set a default address for a customer", "description": "Sets the default address for a customer.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerAddressResponse" } } }, "parameters": [ { "name": "address_id", "description": "Address ID", "in": "path", "required": true, "type": "number" } ], "tags": [ "Customer Address" ], "operationId": "set-default-customer-address-for-a-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] } }, "/admin/customers/{customer_id:[0-9]+}/send_invite.json": { "post": { "summary": "Sends an account invite to a customer.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SendInvitationRequest" } } }, "parameters": [ { "name": "input", "description": "Sends an account invite to a customer.", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/SendInvitationRequest", "description": "Sends an account invite to a customer." } } ], "tags": [ "Customer" ], "operationId": "send-invitation-email-to-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] } }, "/admin/customers/{id:\\\\d+}.json": { "get": { "summary": "Retrieves a single customer.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerDto" } } }, "parameters": [ { "name": "customer_id", "description": "Customer ID.", "in": "path", "required": true, "type": "integer" }, { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Customer" ], "operationId": "retrieves-a-single-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_customers" ] } ] }, "delete": { "summary": "Remove an existing customer", "description": "Deletes a customer. A customer can't be deleted if they have existing orders.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/models.SwaggerDeleteResponse" } } }, "tags": [ "Customer" ], "operationId": "deletes-a-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] }, "put": { "summary": "Updates a customer.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CustomerSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Customer struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CustomerDto", "description": "Customer struct" } } ], "tags": [ "Customer" ], "operationId": "updates-a-customer", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_customers" ] } ] } }, "/admin/domains/connects.json": { "get": { "summary": "Get domain by shop id", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Res" } } }, "tags": [ "Domain" ], "operationId": "get-list-domain-of-the-shop-by-shop-id.", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/draft_orders.json": { "get": { "summary": "Retrieves a list of draft orders", "description": "Retrieves a list of draft orders.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DraftOrdersSwaggerResponse" } } }, "parameters": [ { "name": "fields", "description": "A comma-separated list of fields to include in the response", "in": "path", "required": false, "type": "string" }, { "name": "limit", "description": "Amount of results (default: 50, maximum: 250)", "in": "path", "required": false, "type": "number" }, { "name": "since_id", "description": "Restrict results to after the specified ID", "in": "path", "required": false, "type": "number" }, { "name": "updated_at_min", "description": "Show orders last updated after date", "in": "path", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show orders last updated before date", "in": "path", "required": false, "type": "string" }, { "name": "ids", "description": "Filter by list of IDs", "in": "path", "required": false, "type": "number" }, { "name": "status", "description": "**open**: All open orders (default) \u003cbr\u003e **invoice_sent**: Show only closed orders \u003cbr\u003e **completed**: Show only cancelled orders", "in": "path", "required": false, "type": "string" } ], "tags": [ "DraftOrder" ], "operationId": "retrieves-a-list-of-draft-orders", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "post": { "summary": "Creates a draft order.", "description": "Creates a draft order. Using the DraftOrder resource you can create orders in draft state using product variant line items, or custom line items. To create a product variant draft order, provide the `variant_id`, `quantity` and `discount` properties. To create a custom line item, provide the `title`, `price`, `taxable`, and `quantity` properties.\n\n\u003ccode\u003e \u003e If you are using this endpoint with a Partner development store or a trial store, then you can only create five draft orders per minute.\u003c/code\u003e\n\n### About custom shipping lines\n\nYou can use the DraftOrder resource to send orders with custom shipping lines. A custom shipping line includes a title and price with handle set to Nil. A shipping line with a carrier provided shipping rate (currently set via the ShopBase admin) includes the shipping rate handle.\n\n### Applying discounts\n\nA draft order and its line items can have one discount each. Calculations for discounts are based on the setting of the value_type property, which can be set to either fixed_amount or percentage. For example, you can apply a fixed amount discount to a draft order to reduce the price by the specified value property. When you use a percentage discount, the discount amount property is the price multiplied by the value property. For line item discounts, the value property is applied per individual unit of the item, based on the line item's quantity.\n\n**Calculating line item discount amounts**\n\nFor `fixed_amount` discounts, the total `amount` corresponds to the line item quantity times the value of the discount. For percentage discounts, the total amount corresponds to the following:\n\n`amount` = `floor(price * quantity * value) / 100, where floor()` is the usual round down function.\n\n\n\n\nFor non-fractional currencies, this formula needs to use round() instead of floor(), and the division by 100 takes place inside the rounding, resulting in a non-fractional value. Otherwise, an error is returned.\n\n`amount` = `round(price * quantity * value / 100)`\n\n\n\n\n**Line item examples**\n\n_Fixed amount discount_\n\nFor a $19.99 line item with quantity of 2 and with $5 dollars off, discount amount corresponds to $10 ($5 * 2):\n\n`applied_discount` : `{ \"value_type\": \"fixed_amount\", \"value\": 5, \"amount\": 10}`\n\n_Percentage discount_\n\nFor a $19.99 line item with quantity of 2 and with 15% off, discount amount corresponds to $5.99 (floor ($19.99 * 2 * 15) / 100):\n\n`applied_discount`: `{ \"value_type\": \"percentage\", \"value\": 15, \"amount\": 5.99 }`\n\n### Loading and removing customers\n\nYou can load a customer to a draft order by sending the `customer_id` as part of the draft order object. The recommended way to remove a customer from a draft order is to make a POST request with the Customer object set to null, without specifying an email, shipping address, or billing address. A customer may also be removed by setting `customer`, `email`, `shipping_address` and `billing_address` to `null`", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DraftOrderSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Order input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/OrderDto", "description": "Order input request" } } ], "tags": [ "DraftOrder" ], "operationId": "create-a-draft-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/draft_orders/{draft_order_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieves a specific draft order", "description": "Retrieves a specific draft order.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleDraftOrderSwaggerResponse" } } }, "parameters": [ { "name": "fields", "description": "A comma-separated list of fields to include in the response", "in": "path", "required": false, "type": "string" } ], "tags": [ "DraftOrder" ], "operationId": "receive-a-single-draftorder", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "delete": { "summary": "Deletes a draft order", "description": "Deletes a draft order", "responses": { "200": { "description": "", "schema": null } }, "tags": [ "DraftOrder" ], "operationId": "deletes-a-draft-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "put": { "summary": "Updates a draft order", "description": "Updates a draft order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DraftOrderSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Order input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/OrderRequest", "description": "Order input request" } } ], "tags": [ "DraftOrder" ], "operationId": "update-a-draft-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/fulfillment_services.json": { "get": { "summary": "Receive a list of all FulfillmentServices", "description": "List your app's fulfillment services", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentServicesListSwaggerResponse" } } }, "tags": [ "FulfillmentService" ], "operationId": "receive-a-list-of-all-fulfillmentservices", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_fulfillments" ] } ] }, "post": { "summary": "Create a fulfillment service", "description": "Create a fulfillment service", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleFulfillmentServiceSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/SingleFulfillmentServiceSwaggerResponse", "description": "Request input" } } ], "tags": [ "FulfillmentService" ], "operationId": "create-a-new-fulfillmentservices", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_fulfillments" ] } ] } }, "/admin/fulfillment_services/{id:\\\\d+}.json": { "get": { "summary": "Receive a single FulfillmentServices", "description": "Receive a single FulfillmentServices", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleFulfillmentServiceSwaggerResponse" } } }, "tags": [ "FulfillmentService" ], "operationId": "receive-a-single-fulfillmentservices", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_fulfillments" ] } ] }, "delete": { "summary": "Remove a FulfillmentService from the database", "description": "Remove a FulfillmentService from the database", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/gitlab.SwaggerDeleteResponse" } } }, "tags": [ "FulfillmentService" ], "operationId": "remove-a-fulfillmentservice-from-the-database", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_fulfillments" ] } ] }, "put": { "summary": "Modify an existing FulfillmentService", "description": "Modify an existing FulfillmentService", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleFulfillmentServiceSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/SingleFulfillmentServiceSwaggerResponse", "description": "input request" } } ], "tags": [ "FulfillmentService" ], "operationId": "modify-an-existing-fulfillmentservice", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_fulfillments" ] } ] } }, "/admin/metafields.json": { "get": { "summary": "Retrieves meta fields belong to an resource with options.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseMetafieldsDto" } } }, "parameters": [ { "name": "limit", "description": "Return up to this many results per page. (default: 50, maximum: 250).", "in": "query", "required": false, "type": "integer" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "integer" }, { "name": "created_at_min", "description": "Show metafields created after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Show metafields created before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Show metafields last updated after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show metafields last updated before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" }, { "name": "namespace", "description": "Retrieves metafields with given namespace.", "in": "query", "required": false, "type": "string" }, { "name": "key", "description": "Retrieves metafields with given key.", "in": "query", "required": false, "type": "string" }, { "name": "value_type", "description": "Show only metafields with given value types. Valid values: string, integer, json_string", "in": "query", "required": false, "type": "string" } ], "tags": [ "Metafield" ], "operationId": "retrieves-meta-fields", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "post": { "summary": "Creates new metafield.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseMetafieldDto" } } }, "parameters": [ { "name": "file", "description": "Metafield struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/APIRequestMetafield", "description": "Metafield struct" } } ], "tags": [ "Metafield" ], "operationId": "create-meta-field", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/metafields/count.json": { "get": { "summary": "Retrieves count meta fields belong to an resource with options.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseCountDto" } } }, "parameters": [ { "name": "limit", "description": "Return up to this many results per page. (default: 50, maximum: 250).", "in": "query", "required": false, "type": "integer" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "integer" }, { "name": "created_at_min", "description": "Show metafields created after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Show metafields created before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Show metafields last updated after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show metafields last updated before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "namespace", "description": "Counts metafields with given namespace.", "in": "query", "required": false, "type": "string" }, { "name": "key", "description": "Counts metafields with given key.", "in": "query", "required": false, "type": "string" }, { "name": "value_type", "description": "Counts only metafields with given value types. Valid values: string, integer, json_string", "in": "query", "required": false, "type": "string" } ], "tags": [ "Metafield" ], "operationId": "counts-meta-fields", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/metafields/{metafield_id:[0-9]+}.json": { "get": { "summary": "Retrieves a single metafield by id.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseMetafieldDto" } } }, "parameters": [ { "name": "metafield_id", "description": "Metafield id.", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Metafield" ], "operationId": "retrieves-specific-meta-field", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "delete": { "summary": "Deletes a metafield.", "responses": { "200": { "description": "", "schema": null } }, "parameters": [ { "name": "metafield_id", "description": "Metafield id", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Metafield" ], "operationId": "delete-meta-field", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "put": { "summary": "Updates new metafield.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseMetafieldDto" } } }, "parameters": [ { "name": "file", "description": "Metafield request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/APIRequestMetafield", "description": "Metafield request" } }, { "name": "product_id", "description": "Product ID", "in": "path", "required": true, "type": "integer" }, { "name": "metafield_id", "description": "Metafield ID", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Metafield" ], "operationId": "update-meta-field", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/orders.json": { "get": { "summary": "Retrieves a list of orders", "description": "Retrieve all orders", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrdersSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Orders request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/OrdersSwaggerRequest", "description": "Orders request" } } ], "tags": [ "Order" ], "operationId": "retrieves-a-list-of-orders", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] }, "post": { "summary": "Creates an order", "description": "Creates an order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Order DTO", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/OrderDto", "description": "Order DTO" } } ], "tags": [ "Order" ], "operationId": "creates-an-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/count.json": { "get": { "summary": "Retrieves an order count", "description": "Retrieves an order count", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountResponse" } } }, "parameters": [ { "name": "input", "description": "Order request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/OrdersSwaggerRequest", "description": "Order request" } } ], "tags": [ "Order" ], "operationId": "retrieves-an-order-count", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/orders/{order_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieve a single order", "description": "Retrieves a specific order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Order Request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/OrderRequest", "description": "Order Request" } } ], "tags": [ "Order" ], "operationId": "retrieves-a-specific-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] }, "delete": { "summary": "Deletes an order", "description": "Deletes an order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/models.SwaggerDeleteResponse" } } }, "parameters": [ { "name": "order_id", "description": "Order ID", "in": "path", "required": false, "type": "number" } ], "tags": [ "Order" ], "operationId": "deletes-an-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] }, "put": { "summary": "Updates an order", "description": "Updates an order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderSwaggerResponse" } } }, "parameters": [ { "name": "order_id", "description": "Order ID", "in": "path", "required": true, "type": "integer" }, { "name": "input", "description": "Order Request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/OrderRequest", "description": "Order Request" } } ], "tags": [ "Order" ], "operationId": "updates-an-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:(?:\\\\d+)}/transactions.json": { "get": { "summary": "Retrieves a list of transactions.", "description": "Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderTransactionsSwaggerResponse" } } }, "parameters": [ { "name": "since_id", "description": "Retrieve only transactions after the specified ID.", "in": "query", "required": false, "type": "number" }, { "name": "fields", "description": "Show only certain fields, specifed by a comma-separated list of fields names.", "in": "query", "required": false, "type": "string" }, { "name": "in_shop_currency", "description": "Show amounts in the shop currency.", "in": "query", "required": false, "type": "boolean" } ], "tags": [ "Transaction" ], "operationId": "retrieves-a-list-of-transactions", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] }, "post": { "summary": "Creates a transaction for an order.", "description": "Creates a transaction for an order.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SingleOrderTransactionSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Request input", "in": "body", "required": false, "type": "object", "schema": { "$ref": "#/definitions/TransactionDto", "description": "Request input" } } ], "tags": [ "Transaction" ], "operationId": "creates-a-transaction-for-an-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:(?:\\\\d+)}/transactions/count.json": { "get": { "summary": "Retrieves a count of an order's transactions.", "description": "Count an order's transactions", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountResponse" } } }, "tags": [ "Transaction" ], "operationId": "retrieves-a-count-of-an-order's-transactions", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/orders/{order_id:(?:\\\\d+)}/transactions/{transaction_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieves a specific transaction.", "description": "Retrieve a specific transaction for an order. Transactions attached to multi-currency orders are in the presentment currency by default. To retrieve transactions in the shop currency, include the URL parameter in_shop_currency=true.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderTransactionSwaggerResponse" } } }, "parameters": [ { "name": "fields", "description": "Show only certain fields, specifed by a comma-separated list of fields names.", "in": "query", "required": false, "type": "string" }, { "name": "in_shop_currency", "description": "Show amounts in the shop currency.", "in": "query", "required": false, "type": "boolean" } ], "tags": [ "Transaction" ], "operationId": "retrieves-a-specific-transaction", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/adjust.json": { "put": { "summary": "Adjust quantity or add new custom line item to order.", "description": "Adjust quantity or add new custom line item to order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Order Adjust Request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/AdjustOrderDto", "description": "Order Adjust Request" } } ], "tags": [ "Order" ], "operationId": "adjust-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/cancel.json": { "post": { "summary": "Cancel an order", "description": "Cancel and refund a specific order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderSwaggerResponse" } } }, "parameters": [ { "name": "order_id", "description": "Order ID", "in": "path", "required": true, "type": "integer" }, { "name": "input", "description": "Using an `empty object` to fully cancel and refund an order. To cancel and refund a specific amount of money, use `amount` property. The `refund` property is used to cancel and refund a specific amount of each line items.", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/cancelOrderData", "description": "Using an `empty object` to fully cancel and refund an order. To cancel and refund a specific amount of money, use `amount` property. The `refund` property is used to cancel and refund a specific amount of each line items." } } ], "tags": [ "Order" ], "operationId": "cancel-specific-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/fulfillments.json": { "get": { "summary": "Retrieves fulfillments associated with an order", "description": "Retrieves fulfillments associated with an order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentsSwaggerResponse" } } }, "parameters": [ { "name": "limit", "description": "Limit the amount of results. (default: 50, maximum: 250)", "in": "query", "required": false, "type": "number" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "number" }, { "name": "updated_at_max", "description": "Show fulfillments last updated before date (format: 2019-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Show fulfillments last updated after date (format: 2019-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" } ], "tags": [ "Fulfillment" ], "operationId": "retrieves-fulfillments-associated-with-an-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] }, "post": { "summary": "Create a fulfillment.", "description": "Create a fulfillment for the specified order and line items.\n\nThe fulfillment's status depends on the line items in the order:\n\n* If the line items in the fulfillment use a manual or custom fulfillment service, then the status of the returned fulfillment will be set immediately.\n\n* If the line items use an external fulfillment service, then they will be queued for fulfillment and the status will be set to pending until the external fulfillment service has been invoked.\n\nA fulfillment might then transition to **open**, which implies it is being processed by the service, before transitioning to **success** when the items have shipped. If you don't specify line item IDs, then all unfulfilled and partially fulfilled line items for the order will be fulfilled. However, if an order is refunded or if any of its individual line items are refunded, then the order can't be fulfilled.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentDto" } } }, "parameters": [ { "name": "order_id", "description": "Order ID", "in": "path", "required": true, "type": "integer" }, { "name": "input", "description": "Request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/FulfillRequestWrapperSwagger", "description": "Request input" } } ], "tags": [ "Fulfillment" ], "operationId": "create-fulfillment", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/fulfillments/count.json": { "get": { "summary": "Retrieves a count of fulfillments associated with a specific order", "description": "Count the total number of fulfillments for an order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountFulfillmentsSwaggerResponse" } } }, "parameters": [ { "name": "created_at_min", "description": "Count fulfillments created after date (format: 2019-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Count fulfillments created before date (format: 2019-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Count fulfillments last updated after date (format: 2019-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Count fulfillments last updated before date (format: 2019-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" } ], "tags": [ "Fulfillment" ], "operationId": "retrieves-a-count-of-fulfillments-associated-with-a-specific-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/fulfillments/{fulfillment_id:[0-9]+}.json": { "get": { "summary": "Retrieve a specific fulfillment", "description": "Retrieve a specific fulfillment. \n (fields: Comma-separated list of fields to include in the response.)", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentsSwaggerResponse" } } }, "tags": [ "Fulfillment" ], "operationId": "retrieves-fulfillment", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] }, "put": { "summary": "Update a fulfillment", "description": "Update information associated with a fulfillment", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentSwaggerResponse" } } }, "parameters": [ { "name": "order_id", "description": "Order ID", "in": "path", "required": true, "type": "integer" }, { "name": "fulfillment_id", "description": "Fulfillment ID", "in": "path", "required": true, "type": "integer" }, { "name": "input", "description": "Request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/updateFulfillmentRequest", "description": "Request input" } } ], "tags": [ "Fulfillment" ], "operationId": "update-fulfillment", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/fulfillments/{fulfillment_id:[0-9]+}/cancel.json": { "post": { "summary": "Cancel a fulfillment", "description": "Cancel a fulfillment", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentSwaggerResponse" } } }, "parameters": [ { "name": "order_id", "description": "Order ID", "in": "path", "required": true, "type": "integer" }, { "name": "fulfillment_id", "description": "Fulfillment ID", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Fulfillment" ], "operationId": "cancel-a-fulfillment", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/fulfillments/{fulfillment_id:[0-9]+}/complete.json": { "post": { "summary": "Complete a fulfillment", "description": "Complete a fulfillment", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentSwaggerResponse" } } }, "tags": [ "Fulfillment" ], "operationId": "complete-a-fulfillment", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/fulfillments/{fulfillment_id:[0-9]+}/open.json": { "post": { "summary": "Mark a fulfillment as open", "description": "Transition a fulfillment from pending to open", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FulfillmentSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/FulfillmentSwaggerInput", "description": "Request input" } } ], "tags": [ "Fulfillment" ], "operationId": "mark-a-fulfillment-as-open", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/open.json": { "post": { "summary": "Open-Close a closed order", "description": "Open-Close a closed order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OrderSwaggerResponse" } } }, "parameters": [ { "name": "order_id", "description": "Order ID", "in": "path", "required": true, "type": "string" } ], "tags": [ "Order" ], "operationId": "open-specific-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/refunds.json": { "get": { "summary": "Retrieves a list of refunds for an order.", "description": "Retrieve all refunds from a specific order", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrievesListRefundsSwaggerResponse" } } }, "tags": [ "Refund" ], "operationId": "retrieves-a-list-of-refunds-for-an-order", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] }, "post": { "summary": "Creates a refund", "description": "Creates a refund. Use the calculate endpoint to produce the transactions to submit.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RefundSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute.", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/createRefundRequestBody", "description": "When you use this endpoint with a Partner development store or a trial store, you can create only five refunds per minute." } } ], "tags": [ "Refund" ], "operationId": "create-the-refund", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/refunds/calculate.json": { "post": { "summary": "Calculate the refund", "description": "Calculate the refund.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CalculateRefundSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with ", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CalculateRequestBody", "description": "Calculates refund transactions based on line items and shipping. When you want to create a refund, you should first use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you intend to refund shipping costs. If the restock instructions can't be met—for example, because you try to return more items than have been fulfilled—then the endpoint returns modified restock instructions. You can then use the response in the body of the request to create the actual refund. The response includes a transactions object with " } } ], "tags": [ "Refund" ], "operationId": "calculate-the-refund", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/orders/{order_id:[0-9]+}/refunds/{refund_id:[0-9]+}.json": { "get": { "summary": "Retrieve a specific refund", "description": "Retrieve a specific refund", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrievesRefundsSwaggerResponse" } } }, "tags": [ "Refund" ], "operationId": "retrieve-a-specific-refund", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_orders" ] } ] } }, "/admin/pages.json": { "get": { "summary": "Retrieve a list of all pages", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListPagesSwaggerResponse" } } }, "parameters": [ { "name": "limit", "description": "The maximum number of results to show.", "in": "query", "required": false, "type": "number" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "number" }, { "name": "title", "description": "Retrieve pages with a given title.", "in": "query", "required": false, "type": "string" }, { "name": "handle", "description": "Retrieve a page with a given handle.", "in": "query", "required": false, "type": "string" }, { "name": "created_at_min", "description": "Show pages created after date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Show pages created before date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Show pages last updated after date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show pages last updated before date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show pages last updated before date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "published_at_min", "description": "Show pages published after date (format: 2014-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" }, { "name": "published_status", "description": "Restrict results to pages with a given published status: \u003cbr\u003e * published: Show only published pages. \u003cbr\u003e * unpublished: Show only unpublished pages. \u003cbr\u003e * any: Show published and unpublished pages.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Page" ], "operationId": "retrieves-a-list-pages-of-a-shop-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_content" ] } ] }, "post": { "summary": "Creates a page", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SinglePageSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/SinglePageSwaggerResponse", "description": "input request" } } ], "tags": [ "Page" ], "operationId": "create-a-page", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_content" ] } ] } }, "/admin/pages/plus-base.json": { "get": { "summary": "Retrieve a list of all pages", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListPagesSwaggerResponse" } } }, "parameters": [ { "name": "limit", "description": "The maximum number of results to show.", "in": "query", "required": false, "type": "number" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "number" }, { "name": "title", "description": "Retrieve pages with a given title.", "in": "query", "required": false, "type": "string" }, { "name": "handle", "description": "Retrieve a page with a given handle.", "in": "query", "required": false, "type": "string" }, { "name": "created_at_min", "description": "Show pages created after date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Show pages created before date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Show pages last updated after date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show pages last updated before date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show pages last updated before date (format: 2008-12-31).", "in": "query", "required": false, "type": "string" }, { "name": "published_at_min", "description": "Show pages published after date (format: 2014-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" }, { "name": "published_status", "description": "Restrict results to pages with a given published status: \u003cbr\u003e * published: Show only published pages. \u003cbr\u003e * unpublished: Show only unpublished pages. \u003cbr\u003e * any: Show published and unpublished pages.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Page" ], "operationId": "retrieves-a-list-pages-of-a-shop-id-with-package-is-plusbase", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_content" ] } ] } }, "/admin/pages/{page_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieve a single page", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SinglePageSwaggerResponse" } } }, "parameters": [ { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Page" ], "operationId": "retrieves-a-specific-page", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_content" ] } ] }, "delete": { "summary": "Delete a page", "responses": { "200": { "description": "", "schema": null } }, "tags": [ "Page" ], "operationId": "delete-a-specific-page", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_content" ] } ] }, "put": { "summary": "Updates a page", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SinglePageSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/UpsertPageRequestDto", "description": "input request" } } ], "tags": [ "Page" ], "operationId": "update-a-page", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_content" ] } ] } }, "/admin/payment-simulator.json": { "post": { "summary": "Payment redirect handler", "responses": { "200": { "description": "", "schema": null } }, "parameters": [ { "name": "x_account_id", "description": "Login id of merchant in payment settings", "in": "formData", "required": true, "type": "string" }, { "name": "x_amount", "description": "Order's amount", "in": "formData", "required": true, "type": "integer" }, { "name": "x_currency", "description": "Order's currency", "in": "formData", "required": true, "type": "string" }, { "name": "x_reference", "description": "Unique token for current checkout", "in": "formData", "required": true, "type": "string" }, { "name": "x_shop_name", "description": "Shop's name", "in": "formData", "required": true, "type": "string" }, { "name": "x_signature", "description": "Signed signature", "in": "formData", "required": true, "type": "string" }, { "name": "x_test", "description": "Indicates whether or not this request should be processed in test mode (if supported).", "in": "formData", "required": true, "type": "boolean" }, { "name": "x_url_callback", "description": "URL to which a callback notification should be sent asynchronously.", "in": "formData", "required": true, "type": "string" }, { "name": "x_url_cancel", "description": "URL to which customer must be redirected when they wish to quit payment flow and return to the merchant's site.", "in": "formData", "required": true, "type": "string" }, { "name": "x_url_complete", "description": "URL to which customer must be redirected upon successfully completing payment flow.", "in": "formData", "required": true, "type": "string" }, { "name": "x_customer_billing_address_1", "description": "Customer billing address 1", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_billing_address_2", "description": "Customer billing address 2", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_billing_city", "description": "Customer billing city", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_billing_company", "description": "Customer billing company", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_billing_country", "description": "Customer billing country", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_billing_phone", "description": "Customer billing phone", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_billing_state", "description": "Customer billing state", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_billing_zip", "description": "Customer billing zip code", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_email", "description": "Customer email", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_first_name", "description": "Customer first name", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_last_name", "description": "Customer last name", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_phone", "description": "Customer phone number", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_address_1", "description": "Customer shipping address 1", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_address_2", "description": "Customer shipping address 2", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_city", "description": "Customer shipping city", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_company", "description": "Customer shipping company", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_country", "description": "Customer shipping country", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_first_name", "description": "Customer shipping first name", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_last_name", "description": "Customer shipping last name", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_phone", "description": "Customer shipping phone number", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_state", "description": "Customer shipping state", "in": "formData", "required": false, "type": "string" }, { "name": "x_customer_shipping_zip", "description": "Customer shipping zip", "in": "formData", "required": false, "type": "string" } ], "tags": [ "Payment Simulator" ], "operationId": "post-redirect-handler", "produces": [ "application/json" ] } }, "/admin/payment-simulator/action.json": { "post": { "summary": "Capture, refund or void handler", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentResponseDto" } } }, "parameters": [ { "name": "input", "description": "Request structure", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CaptureRefundOrVoidHandlerSwaggerRequest", "description": "Request structure" } } ], "tags": [ "Payment Simulator" ], "operationId": "capture,-refund-or-void-handler", "produces": [ "application/json" ] } }, "/admin/payment-simulator/check-credential.json": { "post": { "summary": "Credential check", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckCredentialSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Request credential structure", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/CheckCredentialSwaggerRequest", "description": "Request credential structure" } } ], "tags": [ "Payment Simulator" ], "operationId": "check-credential-handler", "produces": [ "application/json" ] } }, "/admin/payment-simulator/transaction.json": { "get": { "summary": "Get transaction", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentResponseDto" } } }, "parameters": [ { "name": "x_account_id", "description": "Login id of merchant in payment settings", "in": "query", "required": true, "type": "string" }, { "name": "x_reference", "description": "Unique token for current checkout", "in": "query", "required": true, "type": "string" }, { "name": "x_signature", "description": "Signed signature", "in": "query", "required": true, "type": "string" }, { "name": "x_test", "description": "Indicates whether or not this request should be processed in test mode (if supported).", "in": "query", "required": true, "type": "boolean" }, { "name": "x_transaction_type", "description": "The valid values are `capture`, `refund`, `void`, `get`. \u003cul\u003e\u003cli\u003e**capture**: Capture the payment.\u003c/li\u003e\u003cli\u003e**refund**: Refund the payment.\u003c/li\u003e\u003cli\u003e**void**: Cancel the payment.\u003c/li\u003e\u003cli\u003e**get**: Get the payment.\u003c/li\u003e\u003c/ul\u003e", "in": "query", "required": true, "type": "string" }, { "name": "x_gateway_reference", "description": "This will only be present in order management", "in": "query", "required": true, "type": "string" } ], "tags": [ "Payment Simulator" ], "operationId": "get-transaction-handler", "produces": [ "application/json" ] } }, "/admin/phub-order/import": { "post": { "summary": "Import order phub by api", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ImportSingleOrderResponse" } } }, "parameters": [ { "name": "input", "description": "BODY import order by api", "in": "body", "required": false, "type": "object", "schema": { "$ref": "#/definitions/ImportSingleOrderRequest" } } ], "tags": [ "PhubOrderApi" ], "operationId": "import-order-via-api", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/phub-order/import/{id:[0-9]+}": { "get": { "summary": "Get phub order import detail by id", "description": "Get phub order import detail by id", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PhubOrderImportRespDto" } } }, "parameters": [ { "name": "id", "description": "PATH phub order import id", "in": "path", "required": true, "type": "integer" } ], "tags": [ "PhubOrderApi" ], "operationId": "get-phub-order-import-by-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/phub-order/update-import-order/{id:[0-9]+}": { "post": { "summary": "Update phub order import detail by id", "description": "Update phub order import detail by id", "responses": { "200": { "description": "OK", "schema": null } }, "parameters": [ { "name": "id", "description": "PATH phub order import id", "in": "path", "required": true, "type": "integer" }, { "name": "input", "description": "BODY import order by api", "in": "body", "required": false, "type": "object", "schema": { "$ref": "#/definitions/ImportSingleOrderRequest" } } ], "tags": [ "PhubOrderApi" ], "operationId": "update-import-order-via-api", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/price_rules.json": { "get": { "summary": "Retrieve a list of price rules", "description": "Retrieve a list of price rules", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PriceRulesResponse" } } }, "parameters": [ { "name": "input", "description": "Price Rules Request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/PriceRulesRequest", "description": "Price Rules Request" } } ], "tags": [ "DiscountCode" ], "operationId": "retrieves-price-rules", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "post": { "summary": "Creates a price rule", "description": "Creates a price rule", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PriceRuleSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/PriceRuleDto", "description": "input request" } } ], "tags": [ "PriceRule" ], "operationId": "create-price-rule", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/price_rules/count.json": { "get": { "summary": "Retrieve a count of all price rules", "description": "Retrieves a count of all price rules.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountPriceRulesSwaggerResponse" } } }, "tags": [ "PriceRule" ], "operationId": "counts-all-price-rules", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/price_rules/{price_rule_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieves a single price rule", "description": "Retrieve a single price rule by its ID", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PriceRuleSwaggerResponse" } } }, "parameters": [ { "name": "price_rule_id", "description": "Price Rule ID", "in": "path", "required": true, "type": "number" } ], "tags": [ "PriceRule" ], "operationId": "retrieves-a-single-price-rule", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "delete": { "summary": "Delete a price rule", "description": "Deletes a price rule", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeletePriceRuleResponse" } } }, "parameters": [ { "name": "price_rule_id", "description": "Price rule ID", "in": "query", "required": true, "type": "number" } ], "tags": [ "PriceRule" ], "operationId": "delete-a-single-price-rule", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "put": { "summary": "Update the title of a price rule", "description": "Updates an existing a price rule", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PriceRuleSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/PriceRuleSwaggerResponse", "description": "input request" } } ], "tags": [ "PriceRule" ], "operationId": "updates-a-single-price-rule", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/price_rules/{price_rule_id:(?:\\\\d+)}/discount_codes.json": { "get": { "summary": "Retrieve a list of all discount codes", "description": "Retrieve a list of discount codes", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiscountCodeResponse" } } }, "parameters": [ { "name": "price_rule_id", "description": "price rule id", "in": "path", "required": true, "type": "number" } ], "tags": [ "DiscountCode" ], "operationId": "get-a-list-discount-code", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "post": { "summary": "Create a discount code", "description": "Creates a discount code", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiscountCodeResponse" } } }, "parameters": [ { "name": "input", "description": "DiscountCode input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/DiscountCodeDto", "description": "DiscountCode input" } } ], "tags": [ "DiscountCode" ], "operationId": "create-a-discount-code", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/price_rules/{price_rule_id:(?:\\\\d+)}/discount_codes/{discount_code_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieve a single discount code", "description": "Retrieves a single discount code", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiscountCodeResponse" } } }, "parameters": [ { "name": "discount_code_id", "description": "Discount Code Id", "in": "path", "required": true, "type": "number" } ], "tags": [ "DiscountCode" ], "operationId": "get-a-discount-code", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "delete": { "summary": "Deletes a discount code", "description": "Deletes a discount code", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteDiscountCodeResponse" } } }, "tags": [ "DiscountCode" ], "operationId": "delete-a-discount-code", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "put": { "summary": "Update the code for a discount", "description": "Updates an existing discount code", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DiscountCodeResponse" } } }, "parameters": [ { "name": "input", "description": "DiscountCode input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/DiscountCodeDto", "description": "DiscountCode input" } } ], "tags": [ "DiscountCode" ], "operationId": "update-a-discount-code", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/products.json": { "get": { "summary": "Retrieves a list of products.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductsSwaggerResponse" } } }, "parameters": [ { "name": "ids", "description": "Return only certain products, specified by a comma-separated list of product IDs.", "in": "query", "required": false, "type": "string" }, { "name": "limit", "description": "Return up to this many results per page. (default: 50, maximum: 250).", "in": "query", "required": false, "type": "integer" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "integer" }, { "name": "title", "description": "Filter results by product title.", "in": "query", "required": false, "type": "string" }, { "name": "vendor", "description": "Filter results by vendor.", "in": "query", "required": false, "type": "string" }, { "name": "handle", "description": "Filter results by handle.", "in": "query", "required": false, "type": "string" }, { "name": "product_type", "description": "Filter results by product type.", "in": "query", "required": false, "type": "string" }, { "name": "collection_id", "description": "Filter results by product collection ID.", "in": "query", "required": false, "type": "integer" }, { "name": "created_at_min", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "published_at_min", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "published_at_max", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "published_status", "description": "Return products by their published status. (default: any), published: Show only published products. unpublished: Show only unpublished products. any: Show all products.", "in": "query", "required": false, "type": "string" }, { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" }, { "name": "presentment_currencies", "description": "Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes.", "in": "query", "required": false, "type": "string" }, { "name": "sort_field", "description": "Sort result-set in ascending or descending order by that field.", "in": "query", "required": false, "type": "string" }, { "name": "sort_mode", "description": "Ascending or descending order. (default: asc)", "in": "query", "required": false, "type": "string" } ], "tags": [ "Product" ], "operationId": "get-all-products", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "delete": { "summary": "Delete multi product.", "description": "Delete multi product along with all its variants and images by ids", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductDeleteMultiSwaggerResponse" } } }, "parameters": [ { "name": "ids", "description": "Product id", "in": "path", "required": true, "type": "integer" }, { "name": "input", "description": "Product delete multi struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductDeleteMultiSwaggerRequest", "description": "Product delete multi struct" } } ], "tags": [ "Product" ], "operationId": "delete-multi-products", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] }, "post": { "summary": "Create a new product.", "description": "Create a new product.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Product request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductSwaggerRequest", "description": "Product request" } } ], "tags": [ "Product" ], "operationId": "create-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] }, "patch": { "summary": "Patch multiple product.", "description": "Patch multi product by options", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PatchProductResponseSwagger" } } }, "parameters": [ { "name": "input", "description": "Patch request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductPatchRequest", "description": "Patch request" } } ], "tags": [ "Product" ], "operationId": "patch-multiple-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/collections.json": { "get": { "summary": "Retrieves a list of products of a collection.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductsByCollectionSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Product request", "in": "body", "required": false, "type": "object", "schema": { "$ref": "#/definitions/handlers.ProductRequest", "description": "Product request" } } ], "tags": [ "Product" ], "operationId": "get-products-by-collection-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/count.json": { "get": { "summary": "Retrieves a count of products.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountResponse" } } }, "parameters": [ { "name": "vendor", "description": "Filter results by product vendor.", "in": "query", "required": false, "type": "string" }, { "name": "product_type", "description": "Filter results by product type.", "in": "query", "required": false, "type": "string" }, { "name": "collection_id", "description": "Filter results by collection ID.", "in": "query", "required": false, "type": "integer" }, { "name": "created_at_min", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "published_at_min", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "published_at_max", "description": "Show products published before date. (format: 2014-04-25T16:15:47-04:00)", "in": "query", "required": false, "type": "string" }, { "name": "published_status", "description": "Return products by their published status", "in": "query", "required": false, "type": "string" } ], "tags": [ "Product" ], "operationId": "get-count-of-all-products", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/tags.json": { "get": { "summary": "Get tags from products", "description": "Get tags from products", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseProductTagsDto" } } }, "parameters": [ { "name": "limit", "description": "returns the number of tags want to display.", "in": "query", "required": false, "type": "integer" } ], "tags": [ "Product" ], "operationId": "get-all-tag-of-product-in-shop", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/types.json": { "get": { "summary": "Get all types from all products", "description": "Get all types from all products", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductGetTypesSwaggerResponse" } } }, "parameters": [ { "name": "limit", "description": "returns the up to this many results", "in": "query", "required": false, "type": "integer" } ], "tags": [ "Product" ], "operationId": "get-all-types-of-products-in-shop", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/vendors.json": { "get": { "summary": "Get all vendors from all products", "description": "Get all vendors from all products", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductGetVendorsSwaggerResponse" } } }, "parameters": [ { "name": "limit", "description": "returns the up to this many results", "in": "query", "required": false, "type": "integer" } ], "tags": [ "Product" ], "operationId": "get-all-vendors-of-products-in-shop", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/{product_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieves a single product.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseProductDto" } } }, "parameters": [ { "name": "product_id", "description": "Product ID.", "in": "path", "required": true, "type": "integer" }, { "name": "fields", "description": "A comma-separated list of fields to include in the response.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Product" ], "operationId": "get-detail-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/{product_id:[0-9]+}/remove_mapping.json": { "delete": { "summary": "Remove mapping of single product from a fulfillment service.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductRemoveMappingResponse" } } }, "parameters": [ { "name": "app_code", "description": "App code, eg: alidropcon, phub...", "in": "query", "required": true, "type": "string" } ], "tags": [ "Product" ], "operationId": "remove-product-mapping-with-fulfillment-services", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/{product_id:[0-9]+}/reorder-options.json": { "put": { "summary": "Reorder product variants", "description": "Reorder product variants.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Product struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductReorderRequest", "description": "Product struct" } } ], "tags": [ "Product" ], "operationId": "reorder-variant-of-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/{product_id}.json": { "delete": { "summary": "Deletes a product.", "description": "Delete a product along with all its variants and images", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SwaggerDeleteResponse" } } }, "parameters": [ { "name": "product_id", "description": "Product ID", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Product" ], "operationId": "delete-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] }, "put": { "summary": "Updates a product.", "description": "Updates a product and its variants and images.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductSwaggerResponse" } } }, "parameters": [ { "name": "product_id", "description": "Product ID", "in": "path", "required": true, "type": "integer" }, { "name": "file", "description": "Product update request struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductUpdateRequestSwagger", "description": "Product update request struct" } } ], "tags": [ "Product" ], "operationId": "update-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/{product_id}/images.json": { "get": { "summary": "Get all product images.", "description": "Get all product images for a product.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AllProductImagesResponseSwagger" } } }, "tags": [ "Product Image" ], "operationId": "get-all-images-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "post": { "summary": "Create a new product image.", "description": "Create a new product image with included image data as att.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateProductImageResponseSwagger" } } }, "parameters": [ { "name": "input", "description": "Product Image Request struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductImageRequest", "description": "Product Image Request struct" } } ], "tags": [ "Product Image" ], "operationId": "create-a-product-image", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] }, "put": { "summary": "Add multi images for multi variants", "description": "Add multi images for multi variants", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateProductImagesVariantsResponseSwagger" } } }, "parameters": [ { "name": "input", "description": "Product update struct ", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/UpdateProductImageRequestSwagger", "description": "Product update struct " } } ], "tags": [ "Product Image" ], "operationId": "update-multi-product-images-for-multi-variants", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/{product_id}/images/count.json": { "get": { "summary": "Get a count of all product images.", "description": "Get a count of all product images.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountProductImagesResponseSwagger" } } }, "tags": [ "Product Image" ], "operationId": "get-count-of-all-images-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/{product_id}/images/{image_id}.json": { "get": { "summary": "Get a single product image by id.", "description": "Show product image.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetProductImageByIdResponseSwagger" } } }, "tags": [ "Product Image" ], "operationId": "get-detail-of-an-image-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "delete": { "summary": "Delete a product image.", "description": "Delete a product image.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteProductImageResponseSwagger" } } }, "tags": [ "Product Image" ], "operationId": "delete-a-product-image", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] }, "put": { "summary": "Update an existing product image.", "description": "Modify an image; change its position and alt tag content.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateProductImageResponseSwagger" } } }, "parameters": [ { "name": "input", "description": "Product update struct ", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/UpdateProductImageRequestSwagger", "description": "Product update struct " } } ], "tags": [ "Product Image" ], "operationId": "update-a-product-image", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/{product_id}/variants.json": { "get": { "summary": "Retrieves a list of product variants.", "description": "Retrieve all variants for a product.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AllVariantResponse" } } }, "parameters": [ { "name": "product_id", "description": "Product ID", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Product Variant" ], "operationId": "get-all-variants-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "post": { "summary": "Create a new product variant.", "description": "Create a new product variant.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseCreateProductVariantDto" } } }, "parameters": [ { "name": "product_id", "description": "Product ID", "in": "path", "required": true, "type": "integer" }, { "name": "input", "description": "Product variant request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/APIRequestCreateProductVariantDto", "description": "Product variant request" } } ], "tags": [ "Product Variant" ], "operationId": "create-a-variant-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/{product_id}/variants/count.json": { "get": { "summary": "Retrieves a count of product variants.", "description": "Retrieve a count all variants for a product.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VariantCountResponse" } } }, "parameters": [ { "name": "product_id", "description": "Product ID", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Product Variant" ], "operationId": "get-count-of-all-variants-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/products/{product_id}/variants/duplicate.json": { "post": { "summary": "Duplicate product variants", "description": "Duplicate product variants", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProductVariantDuplicateResponseSwagger" } } }, "parameters": [ { "name": "input", "description": "Product variant duplicate request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductVariantDuplicateRequest", "description": "Product variant duplicate request" } } ], "tags": [ "Product" ], "operationId": "duplicate--variants-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/products/{product_id}/variants/{variant_id}.json": { "delete": { "summary": "Delete a product variant", "description": "Delete a product variant", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteProductVariantResponse" } } }, "parameters": [ { "name": "product_id", "description": "Product ID", "in": "path", "required": true, "type": "integer" }, { "name": "variant_id", "description": "Variant ID", "in": "path", "required": true, "type": "integer" } ], "tags": [ "Product Variant" ], "operationId": "delete-a-variant-of-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/redirects.json": { "get": { "summary": "Retrieves a list of URL redirects", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RedirectsSwaggerResponse" } } }, "parameters": [ { "name": "limit", "description": "The maximum number of results to show.", "in": "query", "required": false, "type": "number" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "number" }, { "name": "path", "description": "Show redirects with a given path.", "in": "query", "required": false, "type": "string" }, { "name": "target", "description": "Show redirects with a given target.", "in": "query", "required": false, "type": "string" }, { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Redirect" ], "operationId": "retrieves-a-list-redirects-of-a-shop-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_content" ] } ] }, "delete": { "summary": "Deletes redirects", "responses": { "200": { "description": "", "schema": null } }, "tags": [ "Redirect" ], "operationId": "delete-redirects-by-ids", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_content" ] } ] }, "post": { "summary": "Create a redirect", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RedirectsSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/UpsertRedirectRequestDto", "description": "request input" } } ], "tags": [ "Redirect" ], "operationId": "create-a-redirect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_content" ] } ] } }, "/admin/redirects/{redirect_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieves a single redirect", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RedirectSwaggerResponse" } } }, "parameters": [ { "name": "fields", "description": "Show only certain fields, specified by a comma-separated list of field names.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Redirect" ], "operationId": "retrieves-a-specific-redirect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_content" ] } ] }, "delete": { "summary": "Delete a redirect", "responses": { "200": { "description": "", "schema": null } }, "tags": [ "Redirect" ], "operationId": "delete-a-specific-redirect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_content" ] } ] }, "put": { "summary": "Updates an existing redirect", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RedirectsSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/UpsertRedirectRequestDto", "description": "request input" } } ], "tags": [ "Redirect" ], "operationId": "update-a-redirect", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_content" ] } ] } }, "/admin/script_tags.json": { "get": { "summary": "Retrieves a list of all script tags", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScriptTagsSwaggerResponse" } } }, "parameters": [ { "name": "limit", "description": "The maximum number of results to show.", "in": "query", "required": false, "type": "number" }, { "name": "since_id", "description": "Restrict results to after the specified ID.", "in": "query", "required": false, "type": "number" }, { "name": "src", "description": "Show script tags with this URL.", "in": "query", "required": false, "type": "string" }, { "name": "fields", "description": "A comma-separated list of fields to include in the response.", "in": "query", "required": false, "type": "string" } ], "tags": [ "ScriptTag" ], "operationId": "retrieves-a-list-of-script_tags", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_script_tags" ] } ] }, "post": { "summary": "Create a new script tag", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScriptTagSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ScriptTagSwaggerResponse", "description": "Request input" } } ], "tags": [ "ScriptTag" ], "operationId": "create-script_tag", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_script_tags" ] } ] } }, "/admin/script_tags/{script_tag_id}.json": { "get": { "summary": "Retrieves a single script tag", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScriptTagSwaggerResponse" } } }, "parameters": [ { "name": "fields", "description": "A comma-separated list of fields to include in the response.", "in": "query", "required": false, "type": "string" } ], "tags": [ "ScriptTag" ], "operationId": "get-script_tag-by-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_script_tags" ] } ] }, "delete": { "summary": "Deletes a script tag", "responses": { "200": { "description": "", "schema": null } }, "tags": [ "ScriptTag" ], "operationId": "delete-script_tag-by-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_script_tags" ] } ] }, "put": { "summary": "Updates a script tag", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScriptTagSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Request input", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ScriptTagSwaggerResponse", "description": "Request input" } } ], "tags": [ "ScriptTag" ], "operationId": "update-script_tag", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_script_tags" ] } ] } }, "/admin/shop.json": { "get": { "summary": "Retrieves shop.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ShopDto" } } }, "tags": [ "Shop" ], "operationId": "retrieves-the-shop's-configuration", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/smart_collections.json": { "get": { "summary": "Retrieves a list of smart collections.", "description": "Retrieve a list of all smart collections.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetListSmartCollectionSwagger" } } }, "tags": [ "SmartCollection" ], "operationId": "retrieve-a-list-of-smart-collections", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/smart_collections/count.json": { "get": { "summary": "Retrieves a count of collects.", "description": "Retrieves a count of collects.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CountSmartCollectResponseSwagger" } } }, "tags": [ "SmartCollection" ], "operationId": "retrieve-a-count-of-smart-collections", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] } }, "/admin/smart_collections/{smart_collection_id:\\\\d+}.json": { "get": { "summary": "Retrieves a single smart collection.", "description": "Retrieve a specific collection by ID.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetSingleSmartCollectionSwagger" } } }, "tags": [ "SmartCollection" ], "operationId": "retrieve-a-single-smart-collections", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "delete": { "summary": "Removes a smart collection.", "description": "Remove a smart collection.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteSmartCollectResponseSwagger" } } }, "tags": [ "SmartCollection" ], "operationId": "delete-a-smart-collection", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/variants/{variant_id}.json": { "get": { "summary": "Retrieves a single product variant by ID.", "description": "Retrieve a product variant by ID.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VariantByIdSwagger" } } }, "tags": [ "Product Variant" ], "operationId": "get-detail-of-a-variant", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "read_products" ] } ] }, "put": { "summary": "Update the title and price of an existing variant.", "description": "Update the title and price of an existing variant.", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/APIResponseUpdateProductVariantDto" } } }, "parameters": [ { "name": "input", "description": "Product variant struct", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/ProductVariantDtoRequest", "description": "Product variant struct" } } ], "tags": [ "Product Variant" ], "operationId": "update-a-variant-of-a-product", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [ "write_products" ] } ] } }, "/admin/webhooks.json": { "get": { "summary": "Retrieves a list of webhooks", "description": "Retrieves a list of webhooks", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WebhooksSwaggerResponse" } } }, "parameters": [ { "name": "address", "description": "Retrieve webhook subscriptions that send the POST request to this URI.", "in": "query", "required": false, "type": "string" }, { "name": "created_at_max", "description": "Retrieve webhook subscriptions that were created before a given date and time (format: 2014-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "created_at_min", "description": "Retrieve webhook subscriptions that were created after a given date and time (format: 2014-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_min", "description": "Retrieve webhooks that were updated before a given date and time (format: 2014-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "updated_at_max", "description": "Retrieve webhooks that were updated after a given date and time (format: 2014-04-25T16:15:47-04:00).", "in": "query", "required": false, "type": "string" }, { "name": "fields", "description": "Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.", "in": "query", "required": false, "type": "string" }, { "name": "limit", "description": "Maximum number of webhook subscriptions that should be returned. Setting this parameter outside the maximum range will return an error.", "in": "query", "required": false, "type": "number" }, { "name": "since_id", "description": "Restrict the returned list to webhook subscriptions whose id is greater than the specified since_id.", "in": "query", "required": false, "type": "number" }, { "name": "topic", "description": "Show webhook subscriptions with a given topic. Valid topics are: app/uninstalled, carts/create, carts/update, checkouts/create, checkouts/delete, checkouts/update, collection_listings/add, collection_listings/remove, collection_listings/update, collections/create, collections/delete, collections/update, customer_groups/create, customer_groups/delete, customer_groups/update, customers/create, customers/delete, customers/disable, customers/enable, customers/update, draft_orders/create, draft_orders/delete, draft_orders/update, fulfillment_events/create, fulfillment_events/delete, fulfillments/create, fulfillments/update, order_transactions/create, orders/cancelled, orders/create, orders/delete, orders/fulfilled, orders/paid, orders/partially_fulfilled, orders/updated, product_listings/add, product_listings/remove, product_listings/update, products/create, products/delete, products/update, refunds/create, shop/update, themes/create, themes/delete, themes/publish, themes/update, inventory_levels/connect, inventory_levels/update, inventory_levels/disconnect, inventory_items/create, inventory_items/update, inventory_items/delete, locations/create, locations/update, locations/delete, tender_transactions/create", "in": "query", "required": false, "type": "string" } ], "tags": [ "Webhook" ], "operationId": "retrieves-a-list-of-webhooks", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "post": { "summary": "Create a webhook", "description": "Create a webhook subscription's topic or address URIs", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WebhookSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/WebhookSwaggerResponse", "description": "Input request" } } ], "tags": [ "Webhook" ], "operationId": "create-webhook", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } }, "/admin/webhooks/{webhook_id:(?:\\\\d+)}.json": { "get": { "summary": "Retrieves a single of webhooks", "description": "Retrieves a single of webhooks", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WebhookSwaggerResponse" } } }, "parameters": [ { "name": "fields", "description": "Comma-separated list of the properties you want returned for each item in the result list. Use this parameter to restrict the returned list of items to only those properties you specify.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Webhook" ], "operationId": "get-webhook-by-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "delete": { "summary": "Delete a webhook", "description": "Delete a webhook", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SwaggerDeleteResponse" } } }, "tags": [ "Webhook" ], "operationId": "delete-webhook-by-id", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] }, "put": { "summary": "Update a webhook", "description": "Update a webhook subscription's topic or address URIs", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WebhookSwaggerResponse" } } }, "parameters": [ { "name": "input", "description": "Input request", "in": "body", "required": true, "type": "object", "schema": { "$ref": "#/definitions/WebhookSwaggerResponse", "description": "Input request" } } ], "tags": [ "Webhook" ], "operationId": "update-webhook", "produces": [ "application/json" ], "security": [ { "APP_ACCESS_TOKEN": [] } ] } } }, "schemes": [ "https" ], "consumes": null, "produces": null, "definitions": { "APIRequestCreateProductVariantDto": { "properties": { "variant": { "$ref": "#/definitions/ProductVariantRawRequestSwagger" } }, "type": "object" }, "APIRequestMetafield": { "properties": { "metafield": { "$ref": "#/definitions/MetafieldDto" } }, "type": "object" }, "APIResponseCountDto": { "properties": { "count": { "type": "integer" } }, "type": "object" }, "APIResponseCreateProductVariantDto": { "properties": { "variant": { "$ref": "#/definitions/ProductVariantResponse" } }, "type": "object" }, "APIResponseMetafieldDto": { "properties": { "metafield": { "$ref": "#/definitions/MetafieldDto" } }, "type": "object" }, "APIResponseMetafieldsDto": { "properties": { "metafields": { "items": { "$ref": "#/definitions/MetafieldDto" }, "type": "array" } }, "type": "object" }, "APIResponseProductDto": { "properties": { "product": { "$ref": "#/definitions/ProductDto" } }, "type": "object" }, "APIResponseProductTagsDto": { "properties": { "success": { "type": "boolean", "description": "This field is request api success", "example": true }, "tags": { "items": { "type": "string" }, "type": "array", "description": "This field is request api success", "example": [ "tag1", "tag2", "tag3" ] } }, "type": "object" }, "APIResponseUpdateProductVariantDto": { "properties": { "variant": { "$ref": "#/definitions/ProductVariantResponse" } }, "type": "object" }, "AbandonedCheckoutActivitiesSwaggerResponse": { "properties": { "timeline_items": { "items": { "$ref": "#/definitions/Timeline" }, "type": "array" } }, "type": "object" }, "AbandonedCheckoutDto": { "properties": { "abandoned_at": { "type": "string", "example": "2019-04-22T11:00:00-05:00" }, "abandoned_checkout_url": { "type": "string", "description": "Checkout recovery link" }, "abandoned_email_status": { "type": "string", "description": "Email status of this checkout" }, "abandoned_sms_status": { "type": "string", "description": "Sms status of this checkout" }, "billing_address": { "$ref": "#/definitions/CustomerAddressDetail", "description": "Billing address of checkout" }, "billing_address_same_as_shipping_address": { "type": "boolean", "description": "Shipping address and Billing address are same or not" }, "buyer_accepts_marketing": { "type": "boolean", "description": "Is buyer accept marketing" }, "cart_token": { "type": "string", "description": "Cart token", "example": "e2943ee64ff74b4395237c213561c27b" }, "checkout_detail_paid_info": { "$ref": "#/definitions/CheckoutDetailPaidInfo" }, "completed_at": { "type": "string", "example": "2019-04-22T11:00:00-05:00" }, "created_at": { "type": "string", "example": "2019-04-22T11:00:00-05:00" }, "currency": { "type": "string", "description": "Shop currency" }, "customer": { "$ref": "#/definitions/CustomerDto", "description": "Customer info" }, "discount_applications": { "items": { "$ref": "#/definitions/DiscountApplication" }, "type": "array" }, "discount_applied": { "type": "boolean", "description": "Checkout has used discount or not" }, "discount_price": { "type": "number", "description": "Discount amount of checkout" }, "email": { "type": "string", "description": "customer email", "example": "shopbase@shopbase.com" }, "gateway": { "type": "string", "description": "Payment gateway", "example": "stripe" }, "id": { "type": "integer", "description": "Checkout ID", "example": 450789469 }, "line_items": { "items": { "$ref": "#/definitions/OrderLineItemDto" }, "type": "array" }, "lock_send_email_reason": { "type": "string", "description": "Reason not sent email" }, "name": { "type": "string", "description": "Checkout name (base on id)", "example": "#450789469" }, "note": { "type": "string", "description": "Checkout note" }, "phone": { "type": "string", "description": "customer phone number", "example": "+12056685306" }, "real_sent_at": { "type": "string", "example": "2019-04-22T11:00:00-05:00" }, "recovery_email_sent": { "type": "boolean", "description": "Is recovery email sent" }, "scheduled_sent_at": { "type": "string", "example": "2019-04-22T11:00:00-05:00" }, "shipping_address": { "$ref": "#/definitions/CustomerAddressDetail", "description": "Shipping address of checkout" }, "shipping_discount": { "type": "number", "description": "Caculated shipping discount", "example": 2 }, "shipping_fee": { "type": "number", "description": "Caculated shipping fee", "example": 10 }, "shipping_method": { "$ref": "#/definitions/ShippingMethod", "description": "Shipping method info" }, "shipping_name": { "type": "string", "description": "Shipping name" }, "shipping_price": { "type": "number", "description": "Shipping amount of checkout" }, "shipping_tax": { "type": "number", "description": "Caculated shipping tax", "example": 2 }, "shop_id": { "type": "integer", "description": "Shop ID" }, "subtotal_price": { "type": "number", "description": "Subtotal price of checkout" }, "taxes_included": { "type": "boolean", "description": "Is tax included" }, "token": { "type": "string", "description": "Checkout token", "example": "e2943ee64ff74b4395237c213561c27b" }, "total_discounts": { "type": "number", "description": "Total discount amount of checkout" }, "total_line_items_price": { "type": "number", "description": "Total price of line item" }, "total_price": { "type": "number", "description": "Total price of checkout" }, "total_shipping": { "type": "number", "description": "it's equal shipping_fee - shipping_discount + shipping_tax", "example": 10 }, "total_tax": { "type": "number", "description": "Total tax amount" }, "total_weight": { "type": "number", "description": "Cart total weight" }, "updated_at": { "type": "string", "example": "2019-04-22T11:00:00-05:00" } }, "type": "object" }, "AbandonedCheckoutNoteSwaggerRequest": { "properties": { "note": { "type": "string" } }, "type": "object" }, "AbandonedCheckoutsNoteUpdateSwaggerRequest": { "properties": { "checkout": { "$ref": "#/definitions/AbandonedCheckoutNoteSwaggerRequest" } }, "type": "object" }, "AbandonedCheckoutsSwaggerResponse": { "properties": { "checkouts": { "items": { "$ref": "#/definitions/AbandonedCheckoutDto" }, "type": "array" } }, "type": "object" }, "AbandonedCheckoutsUpdateSwaggerResponse": { "properties": { "success": { "type": "boolean" } }, "type": "object" }, "AdditionalInformation": { "properties": { "ASN": { "type": "integer", "description": "ASN" }, "IPS": { "type": "string", "description": "Internet Service Provider", "example": "FPT" }, "city": { "type": "string", "description": "City", "example": "Hanoi" }, "country": { "type": "string", "description": "Country", "example": "example country" }, "hostname": { "type": "string", "description": "Host name", "example": "example host name" }, "latitude": { "type": "string", "description": "Latitude", "example": "27.683528" }, "longitude": { "type": "string", "description": "Longtitude", "example": "27.683528" }, "organization": { "type": "string", "description": "Organization", "example": "example organization" }, "region": { "type": "string", "description": "Region", "example": "VN" }, "timezone": { "type": "string", "description": "Time zone", "example": "7" } }, "type": "object" }, "AdjustLineItemDto": { "properties": { "id": { "type": "integer" }, "is_custom": { "type": "boolean" }, "name": { "type": "string" }, "price": { "type": "number" }, "properties": { "type": "string" }, "quantity": { "type": "number" }, "require_shipping": { "type": "boolean" }, "restock": { "type": "boolean" }, "variant_id": { "type": "integer" } }, "type": "object" }, "AdjustOrderDto": { "properties": { "is_send_email": { "type": "boolean" }, "line_items": { "items": { "$ref": "#/definitions/AdjustLineItemDto" }, "type": "array" }, "reason": { "type": "string" } }, "type": "object" }, "AllProductImagesResponse": { "properties": { "alt": { "type": "string", "example": "new alt tag content" }, "created_at": { "type": "string", "description": "The date and time when the product image was created. The API returns this value in ISO 8601 format.", "example": "2012-03-13T16:09:58-04:00" }, "height": { "type": "integer", "description": "Height dimension of the image which is determined on upload.", "example": 480 }, "id": { "type": "integer", "description": "A unique numeric identifier for the product image.", "example": 850703190 }, "old_image_id": { "type": "integer" }, "position": { "type": "integer", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": 1 }, "product_id": { "type": "integer", "description": "The id of the product associated with the image.", "example": 632910392 }, "src": { "type": "string", "description": "Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).", "example": "https://scn-dev.s3.amazonaws.com/uSKbqtidCG-1553937818736606000.jpg" }, "updated_at": { "type": "string", "description": "The date and time when the product image was last modified. The API returns this value in ISO 8601 format.", "example": "2012-03-13T16:09:58-04:00" }, "updated_source": { "type": "string", "example": "hidden" }, "variant_ids": { "items": { "type": "integer" }, "type": "array", "description": "An array of variant ids associated with the image.", "example": [ 808950810 ] }, "width": { "type": "integer", "description": "Width dimension of the image which is determined on upload.", "example": 640 } }, "type": "object" }, "AllProductImagesResponseSwagger": { "properties": { "images": { "items": { "$ref": "#/definitions/AllProductImagesResponse" }, "type": "array" } }, "type": "object" }, "AllVariantResponse": { "properties": { "variants": { "items": { "$ref": "#/definitions/ProductVariantResponse" }, "type": "array" } }, "type": "object" }, "AppliedDiscount": { "properties": { "amount": { "type": "string", "description": "Discount amount", "example": "10" }, "description": { "type": "string", "description": "Discount description", "example": "example desc" }, "title": { "type": "string", "description": "Discount title", "example": "Super discount" }, "value": { "type": "string", "description": "Discount value", "example": "example value" }, "value_type": { "type": "string", "description": "Discount value type" } }, "type": "object" }, "CalculateLineItemResponse": { "properties": { "discount_amount": { "type": "number", "description": "The discount of the refund line item.", "example": 10.99 }, "discount_per_item": { "type": "number" }, "discounted_price": { "type": "number" }, "discounted_total_price": { "type": "number" }, "line_item_id": { "type": "integer", "description": "The ID of the related line item in the order.", "example": 128323456 }, "price": { "type": "number" }, "quantity": { "type": "integer", "description": "The quantity of the associated line item that was returned.", "example": 2 }, "restock_type": { "type": "string", "description": "How this refund line item affects inventory levels. Valid values\n\u003c/br\u003e**no_restock**: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be returned or made available for sale again.\n\u003c/br\u003e**cancel**: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.\n\u003c/br\u003e**return**: The items were already delivered, and will be returned to the merchant. The returned quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.\n\u003c/br\u003e**legacy_restock**: The deprecated `restock` property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.", "example": "return" }, "subtotal": { "type": "number", "description": "The subtotal of the refund line item.", "example": 10.99 }, "title": { "type": "string", "description": "The title of the refund line item.", "example": "Title" }, "total_cart_discount_amount": { "type": "number" }, "total_refund": { "type": "number", "description": "The total refund on the refund line item.", "example": 2.67 }, "total_tax": { "type": "number", "description": "The total tax on the refund line item.", "example": 2.67 }, "variant_title": { "type": "string", "description": "The variant title of the refund line item.", "example": "Variant title" } }, "type": "object" }, "CalculateRefundSwaggerResponse": { "properties": { "refund": { "$ref": "#/definitions/CalculateResponse" } }, "type": "object" }, "CalculateRequest": { "properties": { "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment.", "example": "USD" }, "refund_line_items": { "items": { "$ref": "#/definitions/RefundLineItem" }, "type": "array", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n * **line_item_id**: The ID of a line item to refund.\n * **quantity**: The quantity to refund.\n * **restock_type**: How this refund line item affects inventory levels. (**no_restock**, **cancel**, **return**).\n * **location_id**: The ID of the location where the items should be restocked. This is required when the value of restock_type is return or cancel. If the item is not already stocked at the location, then the item is connected to the location. An error is returned when the item is connected to a fulfillment service location and a different location is provided." }, "shipping": { "$ref": "#/definitions/Shipping", "description": "Specify how much shipping to refund." } }, "type": "object" }, "CalculateRequestBody": { "properties": { "refund": { "$ref": "#/definitions/CalculateRequest" } }, "type": "object" }, "CalculateResponse": { "properties": { "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the refund.", "example": "USD" }, "maximum_refundable": { "type": "number" }, "payment_gateway_inactive": { "type": "boolean", "description": "Whether the payment gateway is inactive." }, "refund_line_items": { "items": { "$ref": "#/definitions/CalculateLineItemResponse" }, "type": "array", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n * **line_item_id**: The ID of a line item to refund.\n * **quantity**: The quantity to refund.\n * **restock_type**: How this refund line item affects inventory levels. (**no_restock**, **cancel**, **return**).\n * **location_id**: The ID of the location where the items should be restocked. This is required when the value of restock_type is return or cancel. If the item is not already stocked at the location, then the item is connected to the location. An error is returned when the item is connected to a fulfillment service location and a different location is provided." }, "shipping": { "$ref": "#/definitions/CalculateShippingResponse", "description": "Specify how much shipping to refund." }, "support_refund_via_api": { "type": "boolean", "description": "Whether the payment gateway support refunding via API." }, "transactions": { "items": { "$ref": "#/definitions/CalculateTransactionResponse" }, "type": "array", "description": "A list of transactions to process as refunds." } }, "type": "object" }, "CalculateShippingResponse": { "properties": { "amount": { "type": "number" }, "maximum_refundable": { "type": "number" }, "tax": { "type": "number" } }, "type": "object" }, "CalculateTransactionResponse": { "properties": { "amount": { "type": "number", "description": "An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties:\n * **ID**: The ID of the adjustment.\n * **adjustment**: The difference between the amounts on the associated transaction and the parent transaction. \n * **original_amount**: The amount of the parent transaction in the shop currency. \n * **final_amount**: The amount of the associated transaction in the shop currency. \n * **currency**: The shop currency." }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment.", "example": "USD" }, "gateway": { "type": "string", "description": "The name of the gateway the transaction was issued through. A list of gateways can be found on ShopBase's payment gateways page.", "example": "shopbase_payments" }, "kind": { "type": "string", "description": "The transaction's type. Valid values\n* **authorization**: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.\n* **capture**: A transfer of money that was reserved during the authorization of a shop.\n* **sale**: The authorization and capture of a payment performed in one single step.\n* **void**: The cancellation of a pending authorization or capture.\n* **refund**: The partial or full return of captured money to the customer.", "example": "capture" }, "maximum_refundable": { "type": "number", "example": 5 }, "order_id": { "type": "integer", "description": "The ID for the order that the transaction is associated with.", "example": 450789469 }, "parent_id": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed." }, "transaction_currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment.", "example": "EUR" }, "transaction_maximum_refundable": { "type": "number", "example": 4 } }, "type": "object" }, "CaptureRefundOrVoidHandlerSwaggerRequest": { "properties": { "x_account_id": { "type": "string", "description": "Login id of merchant in payment settings" }, "x_amount": { "type": "number", "description": "Order's amount" }, "x_currency": { "type": "string", "description": "Order's currency" }, "x_gateway_reference": { "type": "string", "description": "Unique reference for payment issued by the payment processor." }, "x_invoice": { "type": "string", "description": "Only available on request type = capture" }, "x_reference": { "type": "string", "description": "Unique token for current checkout" }, "x_signature": { "type": "string", "description": "See [Signing mechanism](https://docs.ocg.to/link/4417#bkmrk-2.3%C2%A0signing-mechanis)" }, "x_transaction_type": { "type": "string", "description": "The valid values are `capture`, `refund`, `void`, `get`." }, "x_url_callback": { "type": "string", "description": "URL to which a callback notification should be sent asynchronously." } }, "type": "object" }, "CheckCredentialSwaggerRequest": { "properties": { "x_account_id": { "type": "string", "description": "**Required**\n\u003cp\u003eLogin id of merchant in payment settings\u003c/p\u003e" }, "x_account_password": { "type": "string", "description": "**Required**\n\u003cp\u003eLogin password of merchant in payment settings\u003c/p\u003e" } }, "type": "object" }, "CheckCredentialSwaggerResponse": { "properties": { "x_result": { "type": "string", "description": "The valid values are valid, invalid, restricted.\n* **valid**: Account is valid\n* **invalid**: Account is invalid\n* **restricted**: Account is restricted" } }, "type": "object" }, "CheckoutDetailPaidInfo": { "properties": { "discount_code": { "type": "string" }, "discount_total": { "type": "number" }, "shipping_fee": { "type": "number" }, "shipping_name": { "type": "string" }, "subtotal_price": { "type": "number" }, "tax_total": { "type": "number" }, "total_price": { "type": "number" } }, "type": "object" }, "ClientDetailsDto": { "properties": { "accept_language": { "type": "string", "description": "The languages and locales that the browser understands.", "example": "en-US,en;q=0.9" }, "browser_height": { "type": "integer", "description": "The browser screen height in pixels, if available", "example": 1320 }, "browser_ip": { "type": "string", "description": "The IP address of the browser used by the customer when they placed the order.", "example": "216.191.105.146" }, "browser_width": { "type": "integer", "description": "The browser screen width in pixels, if available.", "example": 1280 }, "session_hash": { "type": "string", "description": "A hash of the session.", "example": "9ad4d1f4e6a8977b9dd98eed1e477643" }, "user_agent": { "type": "string", "description": "Details of the browsing client, including software and operating versions.", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36" } }, "type": "object" }, "Collect": { "properties": { "collection_id": { "type": "integer", "description": "The ID of the custom collection containing the product.", "example": 86733558492 }, "featured": { "type": "boolean", "description": "Whether the collect is featured.", "example": false }, "id": { "type": "integer", "description": "A unique numeric identifier for the collect.", "example": 5435 }, "position": { "type": "number", "description": "The position of this product in a manually sorted custom collection. The first position is 1. This value is applied only when the custom collection is sorted manually.", "example": 2 }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product in the custom collection.", "example": 16011 }, "sort_value": { "type": "string", "description": "This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable. This value is applied only when the custom collection is sorted manually.", "example": "0000000002" } }, "type": "object" }, "CollectByIdResponse": { "properties": { "collection_id": { "type": "integer", "description": "The ID of the custom collection containing the product.", "example": 86733558492 }, "created_at": { "type": "string", "description": "The date and time (ISO 8601 format) when the collect was created.", "example": "2018-04-25T13:51:12-04:00" }, "featured": { "type": "boolean", "description": "Whether the collect is featured.", "example": false }, "id": { "type": "integer", "description": "A unique numeric identifier for the collect.", "example": 5435 }, "position": { "type": "number", "description": "The position of this product in a manually sorted custom collection. The first position is 1. This value is applied only when the custom collection is sorted manually.", "example": 2 }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product in the custom collection.", "example": 16011 }, "sort_value": { "type": "string", "description": "This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable. This value is applied only when the custom collection is sorted manually.", "example": "0000000002" }, "updated_at": { "type": "string", "description": "The date and time (ISO 8601 format) when the collect was last updated.", "example": "updated_at: 2018-04-25T13:51:12-04:00" } }, "type": "object" }, "CollectByIdResponseSwagger": { "properties": { "collect": { "$ref": "#/definitions/CollectByIdResponse" } }, "type": "object" }, "CollectCountResponseSwagger": { "properties": { "count": { "type": "integer", "description": "Get count of collects.", "example": 3 } }, "type": "object" }, "CollectListResponse": { "properties": { "collection_id": { "type": "integer", "description": "The ID of the custom collection containing the product.", "example": 86733558492 }, "created_at": { "type": "string", "description": "The date and time (ISO 8601 format) when the collect was created.", "example": "2018-04-25T13:51:12-04:00" }, "featured": { "type": "boolean", "description": "Whether the collect is featured.", "example": false }, "id": { "type": "integer", "description": "A unique numeric identifier for the collect.", "example": 5435 }, "position": { "type": "number", "description": "The position of this product in a manually sorted custom collection. The first position is 1. This value is applied only when the custom collection is sorted manually.", "example": 2 }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product in the custom collection.", "example": 16011 }, "sort_value": { "type": "string", "description": "This is the same value as position but padded with leading zeroes to make it alphanumeric-sortable. This value is applied only when the custom collection is sorted manually.", "example": "0000000002" }, "updated_at": { "type": "string", "description": "The date and time (ISO 8601 format) when the collect was last updated.", "example": "updated_at: 2018-04-25T13:51:12-04:00" } }, "type": "object" }, "CollectListResponseSwagger": { "properties": { "collects": { "items": { "$ref": "#/definitions/CollectListResponse" }, "type": "array" } }, "type": "object" }, "CollectionByIdResponseSwagger": { "properties": { "custom_collection": { "$ref": "#/definitions/CustomCollectionDto" } }, "type": "object" }, "CollectionCountResponseSwagger": { "properties": { "count": { "type": "integer", "description": "Get count of all collection", "example": 3 } }, "type": "object" }, "CollectionListResponseSwagger": { "properties": { "custom_collection": { "items": { "$ref": "#/definitions/CustomCollectionDto" }, "type": "array" } }, "type": "object" }, "CollectionUpdateRequestSwagger": { "properties": { "custom_collection": { "$ref": "#/definitions/CustomCollectionRequest", "description": "Data of custom collection to update" }, "is_create_redirect": { "type": "boolean", "description": "Flag for create redirect from old custom collection handle to new collection handle or not", "example": true } }, "type": "object" }, "CollectionUpdateResponseSwagger": { "properties": { "body_html": { "type": "string", "description": "The description of the custom collection, complete with HTML markup. Many templates display this on their custom collection pages.", "example": "\u003cp\u003eThe best selling iPods ever\u003c/p\u003e" }, "handle": { "type": "string", "description": "A human-friendly unique string for the custom collection automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the custom collection. (limit: 255 characters)", "example": "IPods" }, "id": { "type": "integer", "description": "The ID for the custom collection", "example": 632910392 }, "image": { "$ref": "#/definitions/CustomCollectionImage", "description": "Image associated with the custom collection. Valid values are" }, "metafields": { "items": { "$ref": "#/definitions/CustomCollectionMetafield" }, "type": "array" }, "published": { "type": "boolean", "description": "A flag mark custom collection is published or not", "example": true }, "sort_order": { "type": "string", "description": "A string repesent sort order of collection", "example": "best-selling" }, "title": { "type": "string", "description": "The name of the custom collection. (limit: 255 characters)", "example": "IPods" } }, "type": "object" }, "CountFulfillmentsSwaggerResponse": { "properties": { "count": { "type": "integer" } }, "type": "object" }, "CountPriceRulesSwaggerResponse": { "properties": { "count": { "type": "integer" } }, "type": "object" }, "CountProductImagesResponseSwagger": { "properties": { "count": { "type": "integer", "description": "All count of all product images.", "example": 3 } }, "type": "object" }, "CountResponse": { "properties": { "count": { "type": "integer" } }, "type": "object" }, "CountSmartCollectResponseSwagger": { "properties": { "count": { "type": "integer", "description": "Get count of SmartCollection.", "example": 3 } }, "type": "object" }, "CreateCollectRequestSwagger": { "properties": { "collect": { "$ref": "#/definitions/CreateCollectResponse" } }, "type": "object" }, "CreateCollectResponse": { "properties": { "collection_id": { "type": "integer", "description": "The ID of the custom collection containing the product.", "example": 86733558492 }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product in the custom collection.", "example": 16011 } }, "type": "object" }, "CreateCollectResponseSwagger": { "properties": { "collect": { "$ref": "#/definitions/Collect" } }, "type": "object" }, "CreateProductImageResponse": { "properties": { "alt": { "type": "string", "example": "new alt tag content" }, "created_at": { "type": "string", "description": "The date and time when the product image was created. The API returns this value in ISO 8601 format.", "example": "2012-03-13T16:09:58-04:00" }, "height": { "type": "integer", "description": "Height dimension of the image which is determined on upload.", "example": 480 }, "id": { "type": "integer", "description": "A unique numeric identifier for the product image.", "example": 850703190 }, "old_image_id": { "type": "integer" }, "position": { "type": "integer", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": 1 }, "product_id": { "type": "integer", "description": "The id of the product associated with the image.", "example": 632910392 }, "src": { "type": "string", "description": "Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).", "example": "https://scn-dev.s3.amazonaws.com/uSKbqtidCG-1553937818736606000.jpg" }, "updated_at": { "type": "string", "description": "The date and time when the product image was last modified. The API returns this value in ISO 8601 format.", "example": "2012-03-13T16:09:58-04:00" }, "updated_source": { "type": "string", "example": "hidden" }, "variant_ids": { "items": { "type": "integer" }, "type": "array", "description": "An array of variant ids associated with the image.", "example": [ 808950810 ] }, "width": { "type": "integer", "description": "Width dimension of the image which is determined on upload.", "example": 640 } }, "type": "object" }, "CreateProductImageResponseSwagger": { "properties": { "images": { "$ref": "#/definitions/CreateProductImageResponse" } }, "type": "object" }, "CurrencyExchangeAdjustmentDto": { "properties": { "adjustment": { "type": "number", "description": "The difference between the amounts on the associated transaction and the parent transaction.", "example": -0.01 }, "currency": { "type": "string", "description": "The shop currency.", "example": "CAD" }, "final_amount": { "type": "number", "description": "The amount of the associated transaction in the shop currency.", "example": -53.63 }, "id": { "type": "integer", "description": "The ID of the adjustment.", "example": 1 }, "original_amount": { "type": "number", "description": "The amount of the parent transaction in the shop currency.", "example": -53.62 } }, "type": "object" }, "CustomCollection": { "properties": { "body_html": { "type": "string", "description": "The description of the custom collection, complete with HTML markup. Many templates display this on their custom collection pages.", "example": "\u003cp\u003eThe best selling iPods ever\u003c/p\u003e" }, "handle": { "type": "string", "description": "A human-friendly unique string for the custom collection automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the custom collection. (limit: 255 characters)", "example": "IPods" }, "id": { "type": "integer", "description": "The ID for the custom collection", "example": 632910392 }, "published": { "type": "boolean", "description": "A flag mark custom collection is published or not", "example": true }, "sort_order": { "type": "string", "description": "A string repesent sort order of collection", "example": "best-selling" }, "title": { "type": "string", "description": "The name of the custom collection. (limit: 255 characters)", "example": "IPods" } }, "type": "object" }, "CustomCollectionDto": { "properties": { "body_html": { "type": "string", "description": "The description of the custom collection, complete with HTML markup. Many templates display this on their custom collection pages.", "example": "\u003cp\u003eThe best selling iPods ever\u003c/p\u003e" }, "handle": { "type": "string", "description": "A human-friendly unique string for the custom collection automatically generated from its title. This is used in shop themes by the Liquid templating language to refer to the custom collection. (limit: 255 characters)", "example": "IPods" }, "id": { "type": "integer", "description": "The ID for the custom collection", "example": 632910392 }, "image": { "$ref": "#/definitions/CustomCollectionImage", "description": "Image associated with the custom collection. Valid values are" }, "metafields": { "items": { "$ref": "#/definitions/CustomCollectionMetafield" }, "type": "array" }, "published": { "type": "boolean", "description": "A flag mark custom collection is published or not", "example": true }, "sort_order": { "type": "string", "description": "A string repesent sort order of collection", "example": "best-selling" }, "title": { "type": "string", "description": "The name of the custom collection. (limit: 255 characters)", "example": "IPods" } }, "type": "object" }, "CustomCollectionImage": { "properties": { "alt": { "type": "string", "description": "Alternative text that describes the collection image.", "example": "iPods" }, "created_at": { "type": "string", "description": "The time and date (ISO 8601 format) when the image was added to the collection.", "example": "2018-04-19T09:34:47-04:00" }, "height": { "type": "integer", "description": "The height of the image in pixels.", "example": 488 }, "src": { "type": "string", "description": "The source URL that specifies the location of the image.", "example": "https://img.btdmp.com/collections/ipod.jpg" }, "width": { "type": "integer", "description": "The width of the image in pixels.", "example": 500 } }, "type": "object" }, "CustomCollectionImageRequest": { "properties": { "alt": { "type": "string", "description": "Alternative text that describes the collection image.", "example": "iPods" }, "attachment": { "type": "string", "description": "An image attached to a custom collection returned as Base64-encoded binary data.", "example": "R0lGODlhbgCMAPf/APbr48VySrxTO7IgKt2qmKQdJeK8lsFjROG5p/nz7Zg3\\nMNmnd7Q1MLNVS9GId71hSJMZIuzTu4UtKbeEeakhKMl8U8WYjfr18YQaIbAf\\nKKwhKdKzqpQtLebFortOOejKrOjZ1Mt7aMNpVbAqLLV7bsNqR+3WwMqEWenN\\nsZYxL/Ddy/Pm2e7ZxLlUQrIjNPXp3bU5MbhENbEtLtqhj5ZQTfHh0bMxL7Ip\\nNsNyUYkZIrZJPcqGdYIUHb5aPKkeJnoUHd2yiJkiLKYiKLRFOsyJXKVDO8up\\nosFaS+TBnK4kKti5sNaYg/z49aqYl5kqLrljUtORfMOlo/36+H4ZH8yDYq0f\\nKKFYTaU9MrY8MrZBNXwXHpgaIdGVYu/byLZNP9SaZLIyOuXCtHkpJst+Wpcm\\nLMyCa8BfP9GMb9KQdPDd1PPk1sd5VP79/L5dQZ0bI9+ymqssK9WcfIoXHdzG\\nxdWWfteib79lSr1YP86MYurQxKdcUKdMQr5ZSfPs6YEZH8uhl4oWIenMuurQ\\nttmejaqoqsqBVaAcJLlJN5kvMLlZRMNsSL5fRak0LbdQQMVvSPjw6cJnRpkf\\nKtmjhvfu5cJtT7IuOMVvWLY/M/37+o0YH9ibhtSYdObErc6HarM9NnYSGNGR\\navLi09unje3WyeO8rsVrT7tdRtK3uffu6NWeaL9pTJIjJrM4NPbx8cdyX7M7\\nPYYVHu7j4KgoNJAYIKtkV5o9MsOcldicis+RYNutfrhFOZ0hJbqinZ8bI8h5\\nUObFuOfItJsfJrJfUOfIqc+PXqQtK8RnSbA4Mcd3Tm0SGbpXQ8aqp7RLNs+s\\novHfzpVhV9iggMd1TLtbRKUdKXEQFsd4XrZRPLIgMZUeJ+jKvrAlK6AhJ65A\\nMpMpKuC3j5obIsRwS7hAN8l/YtvDvnYXHbAoLI47SIUsOMenorF4gO/m4+fH\\npo4vLZ8oKMukqp0cJbhVSMV2UuPR0bAfMLIrLrg/OcJwT8h+Vt+wn8eurLlh\\nQrIfKHQOHHQOHf///////yH5BAEAAP8ALAAAAABuAIwAAAj/AP8JHDhQXjpz\\n/PopXNiPn0OHDRMmbKhQIsOJFS1SxAhxI8SHFzVeDBnx48iNBAeeOkcxokeX\\nFRdOnAlSokaaLXNujJkxo8iYHRkKtWkzZSsaOXkAWsoUECynsHgoqEW1qtVa\\nU7Mq2Mq1K9cUW8GKTUG2rNkUHNByWMuWLdWva7t1W7UKG4S7eO/ycEhQHgaK\\nsL4VGGyocGE3br5929KuxQFFkEtIlgypsuUDmDMfWGRmUZvPoEHfGU36jgDT\\nLQSoVt3IQ2sPsL0IUNZGlZ0H0lo00jEkCytWMspdGzBgn/F9EBIWnKIQlqHB\\nhA0bQpx48Z7UAkoEcMTdUeTJJSxf/4akOTNnzqHb3GkjrUdp0gKwq77jWdod\\nO7dNKWvhRUcWT6zYQI82xB03AAQNCdTKX/xAAB10hfVCnRtbVIhIAy14oJoZ\\nAXS4XXfdQaYIeOGJRx555Z1nRnrqqUeaMtIYY8dmn7Vg2yK57TYEgAzIQGBx\\nxyXHj0A0OOTggxFKSN1iWwTTAIYanpYdMtFE4+GVIHrn3XeUmVhZeWiIMoOY\\nnVQDGiTgKALJjIssIsADt0mjjI6+AXcDgQYi2M8/7ijEwzRIFmBIL9NVV+EW\\nVzyZ4Wqj9RBABchQWeWkV3aY5ZYjjgieeKL446mnjxwAiZVpliAjZqblt19/\\n/7HCwIAFGv+X3J4s9fMckoYhphiTQTwJ5Wqn9dDDAWuMUUEFviTrS6STVlmp\\npVmKqCkOn34aB6TIBAAOJeHZAYl6ptixSCL8edGbq8HFeqBDcygEyIOCGqYk\\nkxUW4euiq7knbA/gUDHGv//ec2wFayQbaQWinOCslVhmSUq1/gCDLJXacgtJ\\nCYu4J66cjbAKoA3CxapnOgm9g+ughdK7xYX3Rinlvj2YYcYanVBBhTg2Axzw\\nG4/4k4bBzDZbKRUQP1LIsRSX6sgBZtwhzQP68ccbj7AWty4/5igEoaC9dK3r\\noVtgs4evvzKqb8wyQ0JFJzXXbDMVcQBQLTDGVmCssstKGs09oPT/jQcRoBw9\\nMamKgEOeeg/gqBtvdVZSDnHFIQgRD4RxXWhiYEOQKNn4zncHzDIzHc0ZpHdy\\nRicIQOypKDf7q3Pd96ABzSab+E1EIYIvS2o0ijA92gPZiCB1qwL+iJxL78Z7\\n2NeHQrAK2YrCZva+bcgcujFUQIEG6WigonoCdLT9tr9UbIIAMMCEkkYacvvT\\nxSgsBPKGJKBEAw4yjhx+hyn+PAJFfztyVdWOt5B3RehyimneFuwFvQxFyTSf\\n25f1zCAqSFACDXTQ3gwSoDoElI5tZyBAINqnuhJ+Kg9vOIOaVnSHT5ECHucK\\n0OMiBxJAPCdXmGseBLoBvei5rFEStB5m/yBhjFJUIw50oIMoLvCpFRAADduj\\nwxvUYMIqmvARCBiDeiwRBk+lQQTEq5qQ3CWdJSkGAlu4y9h66EBgAbF6QhSV\\nMUpQilKcQRNLwIenfpFEJebBioC0ohrQQJ8QhMIfSwhgj2YouYTYUEmGqhBe\\nFNBDH5otgmgLnRyLWMdq0GEGCMCHJjSBjzQE8pSChMLTCJBI4pXDBeuiiA1T\\nprK7PK+SUPphsIQ1wSEag5OUKIUlyiAmAowClci0YizKILUAFi+WDQEEJOmF\\nxlnMYnOVbOP0gkjBTdZRmDiwhCuywcRkmtOEpHjC1DzBABto4xqN5AcgdEXN\\nNO4Ql0+CB2xctv9LM2SSgpXhZB0t0QlT+iMUkzinQquFihD452P0gGdGAPGN\\nHKYxjbOAwBpxqU9+ApGXQgyoQDWRgASwoAMGMMAHDrnQhc5AkQPSU0NgYVF7\\nQmAWKcBnPvc5HwGcbUVxJCInEfACQXQACUhFQkqRwAIOttScv9ABO21wA8k1\\np5Z3mYXYdNqAjvLzbHDUpFCNIQoUdGAdHUhrUg2gVAOg4AXmvEAaOPEGaCCA\\nAASQxBtIYYIq5kEHAaKHVfsRGB3eNBPYxKdXGVWGUnAzdOSxgyg+MIxhoDWt\\nal3rUlXABEBeYBQIiMMm0AAKPBBAE1A4nTjWEIAzvGEFqsvDEHqEjZj/wMKw\\n1rwlVxerGkv4AxVoAOkEmXGMOKDgA8i1LFrRioSjKrWtKRVEQlXHBBSKQhLQ\\nEG3tCHCLJaSWClD0zgHO8LBqDeIYNsDGTG4ryZtak4G7lZ6G2sBSfyCAaTK7\\nAzfgQIEzoOC/yKVsZS+bWeim1BsdqEG10oCANxDgDZwIRHa3O4hbaA91nlKB\\nKA7QBhHo0VPwCFBtAdNea86CZVztKk8FUN5PjQIHxKWABihQBkHY+L/HTa5l\\nMetcAxvAG94wQAQAkA1SIIAUBvUHdkVLgBkMwrvkPSEkVtSCJ/yCAJ5gZ20l\\nwgObziITGk3xTqUHhWoxYQVdAIYINMBmO0TA/8aCwHGOBbwOAvc4pXj2RieY\\nIY69ttgfpJBEHOLQ5ArTAQ2SaPAb4lAC33XsoaxYhUx4kFVrZoKSYlYxbOzg\\nPX8kAM1d6AILOuEDDQzBBCaIwJvhjOMAU7bOmE0qdMUhhFozQhVxiMWnuiAJ\\nQTfZyahFQydWGwA1cbiZAJL0Qiht6UzoVsxetUQaJhEKZzhDBdh+A5s9AQxU\\nq3rVN241ne0sa1rXWgjbqLUd3uqPUYhCFNDAxwzm3d3vjgF/vTvAHegUaYbw\\nwMSZyAR8oX0I2BwiC2eoQQ2srYJA6IDNb2ABqr39bVYDWMfkRgIVzs1xdEOD\\nCjhQ4nXlPe9BaOLQNf+rRjQc0eg2DM8TyvZTs3mY6Xwy4xI2YLMGdIAAhTvD\\nFWzuhKhZIHGKq9riF381rDtQho53/Bjpboc1OiEJktMbtaplrbHboCOYT9rS\\nOdhopocwgiRowOw6L0MNCKCBKjwA26IW9cRTXfE4i1vAlpUEHJze8XTXehvc\\n2AQ05k3vDHaiDGNYeaPNoAzGxbwf/86EHDCd4kbsyBMySII2NH92nevg4TbI\\nA7ZVEGqiF93ocLb7nIdhgGMIoROW4Dvft2GHOqQiDoM3+YWJnT8O7yYL3fgI\\nDwK+CrFX0lwBctUxtLH55qNd5xkYxMKvDffSn/7b4L47JYQgjnW0XvZOv0L/\\nKmz/BS5sIg5QvtkavDPlO/Am+FzOBCBqgU8veEJA9LCBDRjQznIw3/lJEIBs\\n5gqhUIALN3rWR3QTh31IFwcUkAiV1QEOCH4ddw8LkAqpUH5cgAtnIGzikHgs\\nxzSW1w3+Jgc0Bz32Rw8DoA3lQA8yIAP6xwoj4H//B4BJYAOjoAZqYIDWRn0J\\nuIB1Z3fHQAGdgHeJQIEcxwwLQH5csIHEQARE4C9aRx49oAPw5ydyIHaANUPE\\nwXwtmH/6Vw5iKIb/F4DaoAGisAIroIM7WG0MR3pDd3qoJwjVQAEUAAdvEGAG\\nsHcUgITFgAtLmIFNiAtQeAInMAa+UGwiyAEW8QMc//AkgKUNx7EPkLOCLOiC\\nNiADIzCDY0iDm2cHLxCKbNiGPueDcVh02McJ/GWHjfABxyUJdigEfUiB+pAL\\ndVAHX1B+uPCERHAChSAw8QAOHMaIE6EF3MAKkjiJxlGJljgC+UcPm7iJnch8\\nDJAHoRiKaqiDBRgK01d9LDB0QFiHdmiH1YACSDCE4ziLsscIdRCIGriLhfiL\\naxAPOKAKtbARPFAFQKKMywg5XuiC9ACN0TiNOwAAAHCNL5CN2siN3QiHcYhq\\nwCAD6WiHomAJEzmO4LcGueCOG4gLf2OIAjOPOHCPEEFT/KiMzKgNLigDABmN\\nnKgL02aQB3mNCkmKB+iNCv+IBjI2Y+O4ihcZi063DcywkReYi04Yj/ewBmuA\\nAyRYEbAAAVVwkv3oj9rwgizJks4okCMwCI+ACqgwCQaJkGq4hm3IjW8YakPn\\nCWxmhzz5kxfJd3iwkUx4lL0ojw/QlAnxlG4glQYCOStplS8YkJuoCwnwCIY5\\nCYgZljRJlqTYg9WnbTq3lm3plrGojrVWixuJgRpIDB95AgLTCCRYkjeVAXw5\\nlfqXiVa5ks64QSVlmF8JljO5mAtplj4IdJE5YzpHmenYcXCwAHKJi7rIi74Y\\nD7oQms1xU71QmpQ4AOVwmvoHmAH5ABcwna3pmompmAnJmDzIcGp5m2upmxMp\\ni+f/Zg9AIJeCeJSG+ACHAH8OwWyzoJyUCIOnCYOAKQP4wATTeQElVZio8AiI\\nCZtiSZbbuHAIUAXemZu5CZ4YyQ250KAXeJ6c2YsCYIUYwWyZUADK6QoEwAfO\\nOZ8yoANSwAT4SZ37eZjXGZtjOZshoAFQ8HAHOo6TCZ5CgAfluYS4OIhPGA8C\\n4AXBtxBP+WXvWZrZ4ClhYAkdmokzgAkhKqIjqp+GaaIyGaAL+XDOEAEueqC4\\nGaNuKQTWAAQ1OpceCQktcAgcYFuHJQc+wJfhADFpsAPhcJpewAZKKgVL2qTV\\n2ZUnKptqMApJ8ADVZqVYKpkKaodwEAflaYvAuYFE4HIe/8CIEWGhchCkJ7kE\\nJQQAHGoDZcYGckqnTGqnhWmiALqYS5AEdGCAVmqgBvqiMqagquANX3qe8cCo\\njpqX1iQHsAALaWogx5FkEBMO7URCmjqnTJqfJQql2LkClpAEwNCGahABapmq\\nqqqgjAAE3uCgTFgC6tEIZVoRzCYHckBpJ+kBJoQA+xcCqrOpdeqpT/qf2JkF\\nSQAPOdiGLoqq0QqeVOCqDUp+RMBh+7atDgELX+atPJCPKOkAJmQJ7fRH54oJ\\nc7qk+amfn+qfsAkAKqB5SeAFo7CGwBCo3smWlMkMQPaqyAAJi2AaKTBpECB5\\nUdFlKJk6qoMK/McHVsSwdFqnxP9aUv3JrgRghhcbCCswqp0XmdAamTtJmXHg\\nqjWaCmqCIwJwsg/RrSvLA6R5HDIAAyJAAJ3mKQQAAwxwC4Akp8Iqog9bna+5\\nA2V4g+kUgM/HZlUwtB2rparwYzWKB/nzAG3QtBVaq1HxA5+wl8cBA1iABTCg\\nCyGgsK7Af1lrReiariTKn6ggAmTIfDfIAJuntt7pth2bjnAABHKbC74ADi13\\nByfLrQG7sp/AA8dBD4EruIILAy0ABboAA66ATMHKqcMKsZ/aCNMouWrbu2vb\\nthw7kdUgt3VgP41WsinwEPzwb7NgqzzwA3xrCMYBuKu7ujBwvTBAAOYEtrbr\\nqQkwg5z/GLmVa7GWy7EJmo7ccGB4gAxp8i3SMLoNEXnOywOf8AmwsA/aUL3V\\ni726QELJtLi3W1ICWQ7SGLm+67tCi6UeSwGb8GOFkC1L+74uAbAq+7z1Sw0F\\nwACXcAmBy8H6O7sLxb22O52k4IwD2Yk0SL69a763KWOJgAQLACnFBgl267Qy\\nV8H0+wnUgAEb3MMbrL/a+1SaWrNMSgpYqZUEPIY1qMICyMJtCQSB4wv2czjw\\nC3mla8E6nAzcEA4+jAU/HLiJG8IAbMRW6ZLgq8S8e8BOPGM4cDtSDLqboQD4\\neMV8m8VXkAV47MMeDMJP9SmLiw82oAOpicThm8IHXL6BSgEn/4AHhbAsaRLH\\nMSG/e3vBjojHWRADeowFg9DHEMO9DmADDjAK1ZCaLknAhZzGaoyl3IALXHAC\\nMry0cjwR8juwz0sN1OBs3HDJlpwFl8DLvMrJnqKpUADKIUoKD1DGpVzAZ3vI\\nWKoIxNDKr0yysRy/dKzDP3BTChADunzJlxAOygDMJkQANlAGmMCk+CDI0KiV\\nBYzGh9zEOmcDRPCEjEwlI3IACtARkmzB1JBRs9AN3KDN2mzJZQDOJRQGNmAH\\nDSuiyhCYL2jGKIzKCMxmdwCFRMDIb9xo07y8V1y/14wXVxADIA3QWRDEBF0t\\nBi0CAOwKgDkCmmjGpzy+anwPvbjIJ//gyBitvLNswRmVVewQ0iL9yyVt0PVA\\nAIsLBfVJytK4zuXQzknADIZoiIVABNEsx8vWvN/6vJRmU6vw0T4tsyWtOvxn\\nA+EABQCgpID8gqh5lQ6dxGR4yIrgi78o01MdyVY9sJ+QCd+ARlmVzT490F8N\\nMTEQ1gwQDiGwPh260i2dzJ3Yu8eAO/fw2BVwD408w7UAEv9mqyubQBe1Q/98\\nCCA9A38NMSLAf4JtAyFw2Gnd0Il9wmKotm0Q10o5j41svFQtc/M7CwmU1/ZU\\nC559CLrwC6FdLSFA2sR9pB5anw4dvlUZDyE5j/SINKBb2RRx2ZldHUxyFxwQ\\nA70d3NUCBa7/QtyljdrIvdZj6AFKGQ/oTY84YA8PnCb3ON11PQv0dN0QgA1X\\noAuH4Fvc7SkIwABcC97hfdiIvdrgSwnOrd72QAkGDsHSnRDD57wS0g4NcAVb\\ncN1bkAKHcAh+vd95cL3+DeABPp+pjcybeAnojQMobg8JTgmqQAlSrAjSHb8q\\nOwvT0QDocOMTQAJ6UARk4M+HANr77SnY6+Egrn/tdKTjHY2LkOIqruCq8OR2\\n8MYk6ScqSyiGQAI3fuNRsOVRMAEKcAjAHeT+cARD/t8g3k5HLuJHLQMMYA/r\\nreAsbhv48QCUYD8NDnmSR+MF0At/YARGoOXoEAW8QAscMARhHNwh/1DmHm7m\\nxZ3mxw2Y1rDicY4ft/EAlp4tlS3LkndD3ODnfp7lW14EW7AHYu4pg9C6Zc5/\\njE7a+4fkad3iTy7nlW4KtC4N9hAAU47nR1IAwtAMno4Of77labQHrVDqYWC9\\nis61qx7i83kIsU7plk7rppAI1G4K0UCSDp4JbgAdJNAMvv7pOL4YViAPpe4P\\n+pvsy87qrT6ftQHtiUPr1K4M+9EC9nDnlOYDg+EDf+Dt3/7n6EALi0EL+VDu\\nD4DsqI69ql7kjo4F7r4IpiAN8T7vjdAIdmDv74DvPsAN/O7tv14EiUECUQAC\\npV4G+ovsqf7hAH6a1jDr8E7tLaAbE+8FMv//3n6S79MwBDuw7xzv6e2gGBMQ\\nBadQ6gSABQ5AAA4gAodg8kOe8GduCu8O8S7/8jHfH5/HDiWRDH6QA9hwK4PB\\nDfbyBLRAAtPxDbaw5X0g5mlwCXzsMwgABUdw8Aif7ocg7fEu9VP/eUPwCmDw\\nAzPxA+TgBxgQ+BBgMpUjKNQR6FEwB6WuDJdw6AAQuMnO9KQNI3UP8x0DQHoP\\nBmBABnuxEH4f+KAP+LitPNNRDFq+DCN/CSQt3Psb+fyXBZU/8ZevA5mv+Zqf\\nAz/AED+gBeQA+r4f+DkAAShTBKAu8kFOAOFQDQV97oqu6o0g8TFP+7Vv+5Ug\\nC9+q+1PQ+7//+1n/DwFF4O/osAFiDgB4DNT+UPDWC/lljgV23zF5b/vwXwny\\njw3f+hE/kP1TsP36/wxNABBNeEVBp87fQYQJFS5k2NBOjGoEwvxKSOASFowZ\\nscDgyHFIo0ZehrwCU9JkyUopK8nKlIkHP379+P2YMoUcBpw5deZ8RohQE6Cn\\nGg4lOnRGDKRZsoS7pMPSA6YXNWLsKJLkSZOVwKhMGSTTrJf9ZNKcomXKTrQY\\nevr02cSIvKJxi6aJkaVuXaZMs1ziO5UqPawnuXK9AWEW2Jhja9pMuzMd27YW\\nLNga10fuZYUPkdZdqpTv575YbJQbkCHw1sEpb9wQMstwWLFkbfppjJPc/wTI\\nhHhJ5r0BBGbMRzfb7ez5MwwbpTMsx5pa9eob2CBM5yETpmzGtTE8hrybN29b\\nc1oBn6trc9K7nhmUy6BcOUrn0KHLcr0FQvWYMxdnb3w7t/fvwFMiFvKG0uw8\\n4kRLYjkGG0RtMPlWc+GGdyCwbwtYrOsHu7K0a+K/AEO04K0CF8InBvPOg2GE\\nKpZTrsHSUotwwgnnmW4LHGGBKbb9bMqhsSly082CW0QMkDLLSvQHFQFiOESX\\nLGzQpkUY22swA8Lko9EFLqfBEcdvMhRrwx610OLHtJ5Rc01ahHnCzTeFkXNO\\nOfWQkwQ6NNFzTz2X0GQJQAMVdJEYsBhBAyrbK/9tgBcbrCTCG7bkkstvvvwm\\nzPzI7JEcNLXDCYICQhXVkAIMMdWQd0x1Y9VdiuHGA1hjhfWQQzyg9dZDYmBg\\nyioSVfRKFwfYZ8ZIJ3XhGhe83OLSSwEZU78ea+pUO2wK8MFaUUMl9dReDOll\\n1VXbuYIZWWOl1dZDLpGhV3YZXLTR9vZhUMJijUX2mmveYRZcQDLlsCZOp21s\\nCx+uLTjbbE/11ttv3diFkSHKRReGcthtN1hgrdxH2Awk5fJefK+ZZ9lvVvXW\\n2cT+ZSwHgdHCpmCYDb4WYVNL7baXbsN9FdYYbKDA4otddBdYeffZx9iPjw35\\nmmlKNtnUfmXSNNqAW9b/6eWYY8YWYW0V7tYQhxWAwwege61y6OXkbdDoSUFe\\nWuR3wP3akKhjUtlHlqklG+YqsjaY620VNgQDMcQQouwrX3zR6KKFZfttyKtw\\n+utQnRUL2mjLYjnvtLDpu9e9/ZYZ8FK3maLwwn8OmlF3lWNc7df3gfzteaZZ\\n+NTKx5y6RxJ69/333mvBwHOLQ/fhiR2SV34HS47hmnAafJ9gh3AaDMcB7LE/\\nIoPY441dhOzDz94VN3DPNmoeM5drAyfK7lWH34baYetVCidBIT6C5UMhB4r2\\nn3FheSANRVGCwhBmObtlbgqXyYYNyuYFAMQFCtPwQf3spxAraGBRR+Af91wX\\n/zsPoCIuCCAV13yAMsWo7zIOaJHFSHEZHZABdWK4X0JoIAENLIeDCXFA2rgX\\nuwG8MC6kKGGoZuaDTEhtd/vBTBoyYLYqeAEzFpihGCagEBqIQQJVGMAOEdLD\\n2L0uHJdBAMIOhsTELHExwLnS/i6zAQlIQItWxKIccejGL/4wjPvw4kHSQApA\\nBhKQUDCiEWE2C93dTSEW2EMjaWABhbgnA3g8SAj4cElK+kMJWoyjBK6YECtw\\nUgKZ7N8ejdZHfzjgGgNY5SpnZsisJXFHikwICTLBskzUECFtxJ/FFKKETmrx\\nkwixQiclYAX+mfKUCpnBEZzpzHpkS2Yxm0ViMNcjhf+QABs5uKUuD9KoTOaP\\nQb80picxaExk8lCZfIxLNuBhrWnurZpjoiVCbAkBbnrTH2pbTjgZVAVyGnOY\\nBylmJ9P5xXWOUS6WEB3ZqgmTazLxMk40WntQub3lbIOc7OjkQP1RUI4e9CCl\\nfJ3jjCbEogDAE6KrAiKlVs+4gJF7GUDlDLLnUWCyg6Ps8GgxdyrSVK5zH/WI\\noARjZjFEQhSmRCEFg9SGSqIoQadT7alOJcAOoJJUmeFA6VBIETqk+ssPKizK\\nDorxwx9CdShSvapOqzpVoO7ApMocgAdcIb74HeSroEOqEn8w1mgVRR0KyEEw\\nKqoctTZEquzggFsVooepskP/DwqZAAfmakpGvc4HXSXF54CWVLthALASRYhB\\nFpmDd4QxsQxRQmNd61HITnWyCVHC9MTnCsY9U7dH4AM8spGQvVrsiRB4Fg/8\\ncFxsJmQDHvUHLQyhWsy01rXs2MFj2ZGC6862KKRgHGY6K9zlEPdyP8AJcteo\\n3ClsQCHq0AF0QdkN+HbjlxygL31hO13tMrW7lwkB0BiUoR3x4EfmrYlCNjAF\\nCRAoIWmwQexQqQcyxHe+9eXAfVOQAg7k16v7jQsAHGi2Bv0gUzyQQ05Ga+Cy\\n0MBEDsZgN8gQ4QnXt7oJ0QOGOZACDTeEu0aTCwC80EKhDcAHMDGHWATMsuMC\\nFsVl/9GnP0Jg0kw24MUv/qUTOGDlCj8WETfGsVx2vI+UzsATIFZUaTIRk3QY\\n+ZYlFq0Ce5QJHBXgdU+MRCSwEYlVBCHPQZhyn7vhhD9fWdAc2DKhKXxhRCc6\\n0Yi4LOPcl6hGVUFqc4gJLGaxufKO1s2VkrOj63znOkciCKMedZ+n7ARUp1rQ\\niLAyIlyNYURcONaInrWs9ci4JyJOaFYawDzP8Q+ZwAICLckbgd08i290eh9V\\nCIadQw3qO5Oa1H1GNRlSjeorO2HLruZ2rLudAm+Dm9Gxcx/GXmSIMbnjH5W2\\nzy2RbOzM+cENBRAWs0N9b3zXWdp8pra1r61tbXdb4N/2Nv8i5gzeIJd5Gjui\\nwT+AzQ9YVGrYnNO0Agm27GBkvNnNzje+921qf/+b1QEfuMDFPe5lk/lspUG3\\nWKbQCofLBBBuwNEs3C3aikcrB2TTeM81HgmOd3zf/PZ3yFPNaqSXfODF0EDK\\nE9e6liZmCvJwOLD7AQhU2efSbG6zm7VgiG1ofBc+//nGgZ7vbYw67aVux4v/\\nfXSSK53by/HVrzIwDZTBBANUrzpMeAAIWASeB4P/AQ9+cHjEJx7xWgDE5nLQ\\neMdHXvKbg/zkMZ23H/1oFRjYPOc9v3nQ58Aw0xn9LACvO7HQAOZVf/jl0ii1\\nHcXe9bPX3euftaPL5R71tIf97nsy7/o0WlP2r4/JOU7B+r5nqva7jz1EdZ97\\n4qNe+bonfvCfVXvly1762beOOdLBd+Q7PCAAOw==\\n" }, "created_at": { "type": "string", "description": "The time and date (ISO 8601 format) when the image was added to the collection.", "example": "2018-04-19T09:34:47-04:00" }, "height": { "type": "integer", "description": "Height of collection image", "example": 250 }, "src": { "type": "string", "description": "The source URL that specifies the location of the image.", "example": "https://img.btdmp.com/collections/ipod.jpg" }, "width": { "type": "integer", "description": "Width if collection image.", "example": 250 } }, "type": "object" }, "CustomCollectionMetafield": { "properties": { "key": { "type": "string", "description": "A key string for which meta field we use (description_tag, title_tag,..)", "example": "description_tag" }, "namespace": { "type": "string", "description": "sphere of influence of key", "example": "global" }, "value": { "type": "string", "description": "Value of corresponding key", "example": "description_tag" }, "value_type": { "type": "string", "description": "Type of value", "example": "string" } }, "type": "object" }, "CustomCollectionRequest": { "properties": { "body_html": { "type": "string", "description": "The description of the custom collection, complete with HTML markup. Many templates display this on their custom collection pages.", "example": "\u003cp\u003eThe best selling iPods ever\u003c/p\u003e" }, "fields": { "type": "string", "description": "Show only certain fields, specified by a comma-separated list of field names.", "example": "handle,title" }, "handle": { "type": "string", "description": "Url of collection", "example": "dress" }, "id": { "type": "integer", "description": "A unique numeric identifier for the custom collection. Each id is unique across the ShopBase system. No two custom collection will have the same id, even if they're from different shops.", "example": 632910392 }, "image": { "$ref": "#/definitions/CustomCollectionImageRequest", "description": "Image associated with the custom collection. Valid values are" }, "limit": { "type": "integer", "description": "The maximum number of record we want to fetch", "example": 10 }, "metafields": { "items": { "$ref": "#/definitions/CustomCollectionMetafield" }, "type": "array", "description": "An array of meta field value to print in meta tag (for SEO)" }, "page": { "type": "integer", "description": "The current page", "example": 2 }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product in the custom collection.", "example": 632910392 }, "published": { "type": "boolean", "description": "A flag mark custom collection is published or not", "example": true }, "published_status": { "type": "string", "description": "A unique numeric identifier for the product variant. Each id is unique across the ShopBase system. No two products variant will have the same id, even if they're from different shops.", "example": "632910392" }, "sort_order": { "type": "string", "description": "A string repesent sort order of collection", "example": "best-selling" }, "title": { "type": "string", "description": "Title of collection", "example": "Dress" } }, "type": "object" }, "Customer": { "properties": { "accepts_marketing": { "type": "boolean", "description": "Whether the customer has consented to receive marketing material via email.", "example": true }, "average_spent": { "type": "number", "description": "The average amount of money that the customer has spent across their order history.", "example": 37.96 }, "created_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer was created.", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders.", "example": "USD" }, "email": { "type": "string", "description": "The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error.", "example": "test@shopbase.com" }, "first_name": { "type": "string", "description": "The customer's first name.", "example": "John" }, "id": { "type": "integer", "description": "A unique identifier for the customer.", "example": 107333978 }, "last_name": { "type": "string", "description": "The customer's last name.", "example": "English" }, "last_order_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer purchase a last order", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "last_order_id": { "type": "integer", "description": "The ID of the customer's last order.", "example": 234132602919 }, "last_order_name": { "type": "string", "description": "The name of the customer's last order. This is directly related to the name field on the Order resource.", "example": "#1169" }, "last_sent_abandoned_email_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the last abandoned checkout email was sent to this customer", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "note": { "type": "string", "description": "A note about the customer.", "example": "Placed an order that had a fraud warning" }, "orders_count": { "type": "integer", "description": "The number of orders associated with this customer.", "example": 6 }, "phone": { "type": "string", "description": "The unique phone number ([E.164 format](https://en.wikipedia.org/wiki/E.164)) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid:\n * 6135551212 \n * +16135551212 \n * (613)555-1212 \n * +1 613-555-1212", "example": "+16135551111" }, "state": { "type": "string", "description": "The state of the customer's account with a shop. Default value: disabled. Valid values:\n\n * **disabled**: The customer doesn't have an active account. Customer acounts can be disabled from the ShopBase admin at any time.\n * **invited**: The customer has received an emailed invite to create an account.\n * **enabled**: The customer has created an account.\n * **declined**: The customer declined the email invite to create an account.", "example": "disabled" }, "tags": { "type": "string", "description": "Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values.", "example": "loyal" }, "tax_exempt": { "type": "boolean", "description": "Whether the customer is exempt from paying taxes on their order. If ```true```, then taxes won't be applied to an order at checkout. If ```false```, then taxes will be applied at checkout.", "example": true }, "total_spent": { "type": "number", "description": "The total amount of money that the customer has spent across their order history.", "example": 37.96 }, "updated_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer information was last updated.", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "verified_email": { "type": "boolean", "description": "Whether the customer has verified their email address.", "example": true } }, "type": "object" }, "CustomerAddress": { "properties": { "address1": { "type": "string", "description": "The customer's mailing address.", "example": "123 Fake Street" }, "address2": { "type": "string", "description": "An additional field for the customer's mailing address." }, "city": { "type": "string", "description": "The customer's city, town, or village.", "example": "Fakecity" }, "company": { "type": "string", "description": "The customer's company." }, "country_id": { "type": "integer", "description": "A unique identifier for the customer." }, "cpf_or_cnpj_number": { "type": "string", "description": "CPF/CNPJ number", "example": "CPF: 231.234.234-23, CNPJ: 23.123.423/4234-24" }, "created_at": { "type": "string", "description": "Created at time", "format": "date-time" }, "first_name": { "type": "string", "description": "The customer's first name.", "example": "John" }, "id": { "type": "integer", "description": "A unique identifier for the address." }, "last_name": { "type": "string", "description": "The customer's last name.", "example": "Smith" }, "latitude": { "type": "number", "description": "Latitude" }, "longitude": { "type": "number", "description": "Longtitude" }, "phone": { "type": "string", "description": "Phone number\nExample 555-555-5555" }, "province": { "type": "string", "description": "Province", "example": "Ontario" }, "updated_at": { "type": "string", "description": "Updated at time", "format": "date-time" }, "zip": { "type": "string", "description": "ZIP", "example": "K2P 1L4" } }, "type": "object" }, "CustomerAddressCreateForm": { "properties": { "address": { "$ref": "#/definitions/CustomerAddressDetail" } }, "type": "object" }, "CustomerAddressDetail": { "properties": { "address1": { "type": "string", "description": "The customer's mailing address.", "example": "123 Fake Street" }, "address2": { "type": "string", "description": "An additional field for the customer's mailing address." }, "city": { "type": "string", "description": "The customer's city, town, or village.", "example": "Fakecity" }, "company": { "type": "string", "description": "The customer's company." }, "country": { "type": "string", "description": "The customer's country.", "example": "Vietnam" }, "country_code": { "type": "string", "description": "The two-letter country code corresponding to the customer's country.", "example": "VN" }, "country_id": { "type": "integer", "description": "A unique identifier for the customer." }, "country_name": { "type": "string", "description": "The customer's normalized country name.", "example": "Viet nam" }, "cpf_number": { "type": "string", "description": "Brazil CPF Number" }, "cpf_or_cnpj_number": { "type": "string", "description": "CPF/CNPJ number", "example": "CPF: 231.234.234-23, CNPJ: 23.123.423/4234-24" }, "created_at": { "type": "string", "description": "Created at time", "format": "date-time" }, "default": { "type": "boolean", "description": "Whether this address is the default address for the customer." }, "first_name": { "type": "string", "description": "The customer's first name.", "example": "John" }, "id": { "type": "integer", "description": "A unique identifier for the address." }, "last_name": { "type": "string", "description": "The customer's last name.", "example": "Smith" }, "latitude": { "type": "number", "description": "Latitude" }, "longitude": { "type": "number", "description": "Longtitude" }, "name": { "type": "string", "description": "Address name", "example": "example name" }, "phone": { "type": "string", "description": "Phone number\nExample 555-555-5555" }, "province": { "type": "string", "description": "Province", "example": "Ontario" }, "province_code": { "type": "string", "description": "The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada." }, "updated_at": { "type": "string", "description": "Updated at time", "format": "date-time" }, "zip": { "type": "string", "description": "ZIP", "example": "K2P 1L4" } }, "type": "object" }, "CustomerAddressDetailResponse": { "properties": { "customer_address": { "$ref": "#/definitions/CustomerAddressDetail" } }, "type": "object" }, "CustomerAddressExtraData": { "properties": { "country": { "type": "string", "description": "The customer's country.", "example": "Vietnam" }, "country_code": { "type": "string", "description": "The two-letter country code corresponding to the customer's country.", "example": "VN" }, "country_name": { "type": "string", "description": "The customer's normalized country name.", "example": "Viet nam" }, "cpf_number": { "type": "string", "description": "Brazil CPF Number" }, "province_code": { "type": "string", "description": "The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada." } }, "type": "object" }, "CustomerAddressResponse": { "properties": { "customer_address": { "$ref": "#/definitions/CustomerAddressDetail" } }, "type": "object" }, "CustomerAddressesDetailResponse": { "properties": { "addresses": { "items": { "$ref": "#/definitions/CustomerAddressDetail" }, "type": "array" } }, "type": "object" }, "CustomerDto": { "properties": { "accepts_marketing": { "type": "boolean", "description": "Whether the customer has consented to receive marketing material via email.", "example": true }, "addresses": { "items": { "$ref": "#/definitions/CustomerAddressDetail" }, "type": "array", "description": "A list of the ten most recently updated addresses for the customer." }, "average_spent": { "type": "number", "description": "The average amount of money that the customer has spent across their order history.", "example": 37.96 }, "created_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer was created.", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency that the customer used when they paid for their last order. Defaults to the shop currency. Returns the shop currency for test orders.", "example": "USD" }, "default_address": { "$ref": "#/definitions/CustomerAddressDetail", "description": "The default address for the customer." }, "email": { "type": "string", "description": "The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error.", "example": "test@shopbase.com" }, "first_name": { "type": "string", "description": "The customer's first name.", "example": "John" }, "id": { "type": "integer", "description": "A unique identifier for the customer.", "example": 107333978 }, "last_name": { "type": "string", "description": "The customer's last name.", "example": "English" }, "last_order_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer purchase a last order", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "last_order_id": { "type": "integer", "description": "The ID of the customer's last order.", "example": 234132602919 }, "last_order_name": { "type": "string", "description": "The name of the customer's last order. This is directly related to the name field on the Order resource.", "example": "#1169" }, "last_sent_abandoned_email_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the last abandoned checkout email was sent to this customer", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "note": { "type": "string", "description": "A note about the customer.", "example": "Placed an order that had a fraud warning" }, "orders_count": { "type": "integer", "description": "The number of orders associated with this customer.", "example": 6 }, "phone": { "type": "string", "description": "The unique phone number ([E.164 format](https://en.wikipedia.org/wiki/E.164)) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid:\n * 6135551212 \n * +16135551212 \n * (613)555-1212 \n * +1 613-555-1212", "example": "+16135551111" }, "state": { "type": "string", "description": "The state of the customer's account with a shop. Default value: disabled. Valid values:\n\n * **disabled**: The customer doesn't have an active account. Customer acounts can be disabled from the ShopBase admin at any time.\n * **invited**: The customer has received an emailed invite to create an account.\n * **enabled**: The customer has created an account.\n * **declined**: The customer declined the email invite to create an account.", "example": "disabled" }, "tags": { "type": "string", "description": "Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values.", "example": "loyal" }, "tax_exempt": { "type": "boolean", "description": "Whether the customer is exempt from paying taxes on their order. If ```true```, then taxes won't be applied to an order at checkout. If ```false```, then taxes will be applied at checkout.", "example": true }, "total_spent": { "type": "number", "description": "The total amount of money that the customer has spent across their order history.", "example": 37.96 }, "updated_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the customer information was last updated.", "format": "date-time", "example": "2012-08-24T14:01:46-04:00" }, "verified_email": { "type": "boolean", "description": "Whether the customer has verified their email address.", "example": true } }, "type": "object" }, "CustomerForResponse": { "properties": { "customers": { "items": { "$ref": "#/definitions/CustomerDto" }, "type": "array" } }, "type": "object" }, "CustomerInvite": { "properties": { "bcc": { "items": { "type": "string" }, "type": "array" }, "custom_message": { "type": "string" }, "from": { "type": "string", "example": "steve@apple.com" }, "subject": { "type": "string", "example": "Customer account activation" }, "to": { "type": "string", "example": "bob.norman@hostmail.com" } }, "type": "object" }, "CustomerSwaggerResponse": { "properties": { "customer": { "$ref": "#/definitions/CustomerDto" } }, "type": "object" }, "DeleteCollectResponseSwagger": { "properties": { "success": { "type": "boolean", "description": "Api response success", "example": true } }, "type": "object" }, "DeleteCustomCollectionResponseSwagger": { "properties": { "success": { "type": "boolean" } }, "type": "object" }, "DeleteDiscountCodeResponse": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "type": "object" }, "DeletePriceRuleResponse": { "properties": { "message": { "type": "string" }, "success": { "type": "boolean" } }, "type": "object" }, "DeleteProductImageResponseSwagger": { "type": "object" }, "DeleteProductVariantResponse": { "properties": { "success": { "type": "boolean", "description": "This field is request api success", "example": true } }, "type": "object" }, "DeleteSmartCollectResponseSwagger": { "properties": { "success": { "type": "boolean", "description": "Remove a smart collection.", "example": true } }, "type": "object" }, "DiscountApplication": { "properties": { "allocation_method": { "type": "string" }, "amount": { "type": "number" }, "code": { "type": "string" }, "discount_type": { "type": "string" }, "is_valid": { "type": "boolean" }, "price_rule_id": { "type": "integer" }, "price_rule_title": { "type": "string" }, "price_rule_type": { "type": "string" }, "scope": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "number" }, "value_type": { "type": "string" } }, "type": "object" }, "DiscountCodeDto": { "properties": { "code": { "type": "string", "description": "The case-insensitive discount code that customers use at checkout. (maximum: 255 characters)\n ```Use the same value for code as the title property of the associated price rule.```", "example": "SUMMERSALE10OFF" }, "created_at": { "type": "string", "description": "The date and time (ISO 8601 format) when the discount code was created.", "example": "2019-04-19T16:09:54-04:00" }, "id": { "type": "integer", "description": "The ID for the discount code.", "example": 898668068 }, "price_rule": { "$ref": "#/definitions/PriceRuleDto", "description": "PriceRule" }, "price_rule_id": { "type": "integer", "description": "The ID for the price rule that this discount code belongs to.", "example": 423748927342 }, "scope": { "type": "string", "description": "scope shopbase, printbase" }, "shop_id": { "type": "integer", "description": "shop id", "example": 896781590 }, "updated_at": { "type": "string", "description": "The date and time (ISO 8601 format) when the discount code was updated.", "example": "2019-04-19T16:09:54-04:00" }, "usage_count": { "type": "integer", "description": "The number of times that the discount code has been redeemed.", "example": 6 } }, "type": "object" }, "DiscountCodeResponse": { "properties": { "discount_code": { "$ref": "#/definitions/DiscountCodeDto" } }, "type": "object" }, "DisplayOption": { "properties": { "group_options_by": { "type": "integer" } }, "type": "object" }, "DisplayOptions": { "properties": { "group_options_by": { "type": "integer", "description": "Group option by specific field", "example": 1 } }, "type": "object" }, "DraftOrderSwaggerResponse": { "properties": { "draft_order": { "$ref": "#/definitions/OrderDto" } }, "type": "object" }, "DraftOrdersSwaggerResponse": { "properties": { "draft_orders": { "items": { "$ref": "#/definitions/OrderDto" }, "type": "array" } }, "type": "object" }, "FailureResponse": { "properties": { "message": { "type": "string", "description": "If un-success, response error message.", "example": "invalid Refund amount" }, "success": { "type": "boolean", "description": "Is Refund failure.", "example": false } }, "type": "object" }, "FilterRule": { "properties": { "column": { "type": "string" }, "condition": { "type": "string" }, "relation": { "type": "string" } }, "type": "object" }, "FulfillRequestSwagger": { "properties": { "line_items": { "items": { "$ref": "#/definitions/LineItemFulfillRequestSwagger" }, "type": "array", "description": "Tracking number of fulfillment" }, "service": { "type": "string", "description": "Service name of fulfillment", "example": "ali-dropship-connector" }, "shipment_status": { "type": "string", "description": "The current shipment status of fulfillment" }, "tracking_company": { "type": "string", "description": "Tracking company of fulfillment", "example": "17track.net" }, "tracking_number": { "type": "string", "description": "Tracking number of fulfillment", "example": "LO55960699CN" }, "tracking_url": { "type": "string", "description": "Tracking url of fulfillment, only use one of `tracking_url` and `tracking_urls`", "example": "https://t.17track.net/en#nums=LO55960699CN" }, "tracking_urls": { "items": { "type": "string" }, "type": "array", "description": "Tracking urls of fulfillment, only use one of `tracking_url` and `tracking_urls`", "example": [ "https://t.17track.net/en#nums=LO55960699CN" ] } }, "type": "object" }, "FulfillRequestWrapperSwagger": { "properties": { "fulfillment": { "$ref": "#/definitions/FulfillRequestSwagger" } }, "type": "object" }, "Fulfillment": { "properties": { "created_at": { "type": "integer", "description": "The date and time when the fulfillment was created. The API returns this value in ISO 8601 format." }, "date_done": { "type": "integer", "description": "The date and time when the fulfillment was fulfilled. The API returns this value in ISO 8601 format." }, "detected_tracking_company": { "type": "string", "description": "Detected tracking company" }, "first_tracking_step_at": { "type": "integer", "description": "The date and time when the first tracking step created" }, "id": { "type": "integer", "description": "The ID for the fulfillment.", "example": 255858046 }, "last_crawled_at": { "type": "integer", "description": "The date and time when the fulfillment was last crawled" }, "last_mile_tracking_company": { "type": "string", "description": "Last mile tracking company" }, "last_mile_tracking_number": { "type": "string", "description": "Last mile tracking number" }, "last_response_log": { "type": "string", "description": "Save last response of failed status" }, "last_tracking_step_at": { "type": "integer", "description": "The date and time when the last tracking step created" }, "line_items": { "items": { "$ref": "#/definitions/LineItemFulfillment" }, "type": "array", "description": "Fulfillment line items" }, "name": { "type": "string", "description": "The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number.\nThe fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).", "example": "255858046" }, "notify_customer": { "type": "boolean", "description": "Whether the customer should be notified. \n If set to true, then an email will be sent when the fulfillment is created or updated. \n For orders that were initially created using the API, the default value is false.\n For all other orders, the default value is true.", "example": true }, "order_id": { "type": "integer", "description": "The unique numeric identifier for the order.", "example": 450789469 }, "send_delay_mail": { "type": "boolean", "description": "check send email delay shipping" }, "service": { "type": "string", "description": "The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number.\n The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).", "example": "255858046" }, "shipment_status": { "type": "string", "description": "The current shipment status of the fulfillment. Valid values: \n * **attempted_delivery**: Delivery of the shipment was attempted, but unable to be completed.\n * **ready_for_pickup**: The shipment is ready for pickup at a shipping depot.\n * **confirmed**: The carrier is aware of the shipment, but hasn't received it yet. \n * **in_transit**: The shipment is being transported between shipping facilities on the way to its destination.\n * **out_for_delivery**: The shipment is being delivered to its final destination.\n * **delivered**: The shipment was successfully delivered.\n * **delayed**: The tracking status need more time to be updated (maybe cause by shipping carrier website issue), probably will be ready in 6~12 hours. \n * **failure, not_found, invalid**: Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.", "example": "confirmed" }, "status": { "type": "string", "description": "The status of the fulfillment. Valid values: \n * **pending**: The fulfillment is pending. \n * **open**: The fulfillment has been acknowledged by the service and is in processing. \n * **success**: The fulfillment was successful. \n * **cancelled**: The fulfillment was cancelled. \n * **error**: There was an error with the fulfillment request. \n * **failure**: he fulfillment request failed.", "example": "255858046" }, "tracking_company": { "type": "string", "description": "The name of the tracking company.", "example": "4PX" }, "tracking_numbers": { "items": { "type": "string" }, "type": "array", "description": "A list of tracking numbers, provided by the shipping company.", "example": [ "112345Z2345" ] }, "tracking_steps": { "type": "string", "description": "Tracking steps" }, "tracking_urls": { "items": { "type": "string" }, "type": "array", "description": "The URLs of tracking pages for the fulfillment.", "example": [ "http://track-example.com/startairmail.php?code=112345Z2345" ] }, "updated_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the fulfillment was last modified." }, "variant_inventory_management": { "type": "string", "description": "The name of the inventory management service.", "example": "shopbase" } }, "type": "object" }, "FulfillmentDto": { "properties": { "claim_id": { "type": "integer", "description": "the claim id of fulfillment" }, "created_at": { "type": "integer", "description": "The date and time when the fulfillment was created. The API returns this value in ISO 8601 format." }, "date_done": { "type": "integer", "description": "The date and time (ISO 8601 format) when the fulfillment was fulfilled." }, "detected_tracking_company": { "type": "string", "description": "Detected tracking company" }, "first_tracking_step_at": { "type": "integer", "description": "The date and time when the first tracking step created" }, "id": { "type": "integer", "description": "The ID for the fulfillment.", "example": 255858046 }, "last_crawled_at": { "type": "integer", "description": "The date and time when the fulfillment was last crawled" }, "last_mile_tracking_company": { "type": "string", "description": "The tracking company when the package arrived at destination country" }, "last_mile_tracking_number": { "type": "string", "description": "The tracking number of packages when arrived at destination country" }, "last_tracking_step_at": { "type": "integer", "description": "The date and time when the last tracking step created" }, "name": { "type": "string", "description": "The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number.\nThe fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).", "example": "255858046" }, "notify_customer": { "type": "boolean", "description": "Whether the customer should be notified. \n If set to true, then an email will be sent when the fulfillment is created or updated.\nFor orders that were initially created using the API, the default value is false.\nFor all other orders, the default value is true.", "example": true }, "order_id": { "type": "integer", "description": "The unique numeric identifier for the order.", "example": 450789469 }, "send_delay_mail": { "type": "boolean", "description": "check send email delay shipping" }, "service": { "type": "string", "description": "The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number.\nThe fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).", "example": "255858046" }, "shipment_status": { "type": "string", "description": "The current shipment status of the fulfillment. Valid values\n\u003c/br\u003e**label_printed**: A label for the shipment was purchased and printed.\n\u003c/br\u003e**label_purchased**: A label for the shipment was purchased, but not printed.\n\u003c/br\u003e**attempted_delivery**: Delivery of the shipment was attempted, but unable to be completed.\n\u003c/br\u003e**ready_for_pickup**: The shipment is ready for pickup at a shipping depot.\n\u003c/br\u003e**confirmed**: The carrier is aware of the shipment, but hasn't received it yet.\n\u003c/br\u003e**in_transit**: The shipment is being transported between shipping facilities on the way to its destination.\n\u003c/br\u003e**out_for_delivery**: The shipment is being delivered to its final destination.\n\u003c/br\u003e**delivered**: The shipment was succesfully delivered.\n\u003c/br\u003e**failure**: Something went wrong when pulling tracking information for the shipment, such as an invalid tracking number or the shipment was cancelled.", "example": "confirmed" }, "status": { "type": "string", "description": "The status of the fulfillment. Valid values\n\u003c/br\u003e**pending**: The fulfillment is pending.\n\u003c/br\u003e**open**: The fulfillment has been acknowledged by the service and is in processing.\n\u003c/br\u003e**success**: The fulfillment was successful.\n\u003c/br\u003e**cancelled**: The fulfillment was cancelled.\n\u003c/br\u003e**error**: There was an error with the fulfillment request.\n\u003c/br\u003e**failure**: the fulfillment request failed.\n\u003c/br\u003e**processing**: the fulfillment request is in processing.", "example": "255858046" }, "tracking_company": { "type": "string", "description": "The name of the tracking company.", "example": "4PX" }, "tracking_number": { "type": "string", "description": "A trackping number, provided by the shipping company", "example": "1Z2345" }, "tracking_numbers": { "items": { "type": "string" }, "type": "array", "description": "A list of tracking numbers, provided by the shipping company.", "example": [ "112345Z2345" ] }, "tracking_steps": { "type": "object", "description": "Tracking steps object" }, "tracking_url": { "type": "string", "description": "Link to tracking pag", "example": "http://example.com/etracking/tracking.cgi?InquiryNumber1=1Z2345\u0026TypeOfInquiryNumber=T\u0026AcceptUPSLicenseAgreement=yes\u0026submit=Track" }, "tracking_urls": { "items": { "type": "string" }, "type": "array", "description": "The URLs of tracking pages for the fulfillment.", "example": [ "http://track-example.com/startairmail.php?code=112345Z2345" ] }, "updated_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the fulfillment was last modified." }, "variant_inventory_management": { "type": "string", "description": "The name of the inventory management service.", "example": "shopbase" } }, "type": "object" }, "FulfillmentService": { "properties": { "can_remove_mapping": { "type": "boolean", "description": "Can remove mapping or not", "example": true }, "is_mapped": { "type": "boolean", "description": "Whether is mapped or not", "example": true }, "service_name": { "type": "string", "description": "Service name", "example": "Service name" } }, "type": "object" }, "FulfillmentServicesListSwaggerResponse": { "properties": { "fulfillment_services": { "items": { "$ref": "#/definitions/FulfillmentService" }, "type": "array" } }, "type": "object" }, "FulfillmentSwaggerInput": { "properties": { "fulfillment": { "$ref": "#/definitions/Fulfillment" } }, "type": "object" }, "FulfillmentSwaggerResponse": { "properties": { "fulfillment": { "$ref": "#/definitions/OrderFulfillmentDto" } }, "type": "object" }, "FulfillmentsSwaggerResponse": { "properties": { "fulfillments": { "items": { "$ref": "#/definitions/OrderFulfillmentDto" }, "type": "array" } }, "type": "object" }, "GetListSmartCollectionSwagger": { "properties": { "smart_collections": { "items": { "$ref": "#/definitions/CustomCollectionDto" }, "type": "array" } }, "type": "object" }, "GetProductImageByIdResponseSwagger": { "properties": { "images": { "$ref": "#/definitions/ProductImageDTO" } }, "type": "object" }, "GetSingleSmartCollectionSwagger": { "properties": { "smart_collection": { "$ref": "#/definitions/CustomCollectionDto" } }, "type": "object" }, "ImportLineItem": { "properties": { "artwork_back_url": { "type": "string" }, "artwork_front_url": { "type": "string" }, "color": { "type": "string" }, "lineitem_quantity": { "type": "integer", "description": "Line item quantity", "example": 10 }, "lineitem_sku": { "type": "string", "description": "Line item sky", "example": "example" }, "mockup_back_url": { "type": "string" }, "mockup_front_url": { "type": "string" }, "name": { "type": "string", "description": "Line item name", "example": "example name" }, "product_id": { "type": "string", "description": "Product id", "example": "example_id" }, "product_name": { "type": "string", "description": "Product name", "example": "example name" }, "reference_id": { "type": "string", "description": "Ref id", "example": "example" }, "size": { "type": "string" }, "supplier_id": { "type": "integer" }, "supplier_name": { "type": "string" }, "supplier_product_color": { "type": "string" }, "supplier_product_size": { "type": "string" } }, "type": "object" }, "ImportSingleOrderRequest": { "properties": { "line_items": { "items": { "$ref": "#/definitions/ImportLineItem" }, "type": "array" }, "name": { "type": "string", "description": "Order name", "example": "example name" }, "shipping_address_1": { "type": "string", "description": "Shipping address", "example": "example address" }, "shipping_address_2": { "type": "string", "description": "Shipping address", "example": "example address" }, "shipping_city": { "type": "string", "description": "Shipping city", "example": "example city" }, "shipping_country": { "type": "string", "description": "Shipping country", "example": "example country" }, "shipping_name": { "type": "string", "description": "Shipping name", "example": "example name" }, "shipping_phone": { "type": "string", "description": "Shipping phone", "example": "012312302930" }, "shipping_province": { "type": "string", "description": "Shipping province", "example": "example province" }, "shipping_zip": { "type": "string", "description": "Shipping zip code", "example": "12345" }, "shop_id": { "type": "integer", "description": "Shop id", "example": 123456 } }, "type": "object" }, "ImportSingleOrderResponse": { "properties": { "order_id": { "type": "integer" } }, "type": "object" }, "ItemBasedShippingRateDto": { "properties": { "additional_item_price": { "type": "number" }, "created_at": { "type": "integer" }, "exclude_rules": { "items": { "$ref": "#/definitions/FilterRule" }, "type": "array" }, "first_item_price": { "type": "number" }, "group_tag": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price_unit": { "type": "string" }, "rules": { "items": { "$ref": "#/definitions/FilterRule" }, "type": "array" }, "shipping_zone_id": { "type": "integer" }, "shop_id": { "type": "integer" }, "updated_at": { "type": "integer" } }, "type": "object" }, "ItemTotalsDto": { "properties": { "discount_amount": { "type": "number", "description": "Discount amount", "example": 1 }, "item_discount_price": { "type": "number", "description": "Item discount price", "example": 20 }, "line_item_discount_amount": { "type": "number", "description": "Line item discount amount", "example": 20 }, "line_item_discount_price": { "type": "number", "description": "Line item discount price", "example": 100 }, "line_item_price": { "type": "number", "description": "Line item price", "example": 100 }, "line_item_price_after_discount": { "type": "number", "description": "Line item price after discount", "example": 20 }, "line_item_price_before_discount": { "type": "number", "description": "Line item price before discount", "example": 20 }, "line_item_price_with_explicit_discount": { "type": "number", "description": "Line item price with explicit discount", "example": 10 }, "line_item_weight": { "type": "number", "description": "Line item weight", "example": 10 }, "not_explicit_discount_price": { "type": "number", "description": "Not explitcit discount price", "example": 2 }, "quantity": { "type": "number", "description": "Quantity items", "example": 1000 }, "raw_price": { "type": "number", "description": "Raw price", "example": 20 }, "raw_weight": { "type": "number", "description": "Raw weight", "example": 10 }, "tax_amount": { "type": "number", "description": "Tax amount", "example": 20 }, "tax_rate": { "type": "number", "description": "Tax rate", "example": 1 }, "total_item_discount_price": { "type": "number", "description": "Total item discount price", "example": 10 }, "total_line_with_discount_price": { "type": "number", "description": "Total line with discount price", "example": 10 }, "total_tax_amount": { "type": "number", "description": "Total tax amount", "example": 10 }, "weight_unit": { "type": "string", "description": "Weight unit", "example": "Kg" } }, "type": "object" }, "Layer": { "properties": { "base_product_id": { "type": "integer" }, "name": { "type": "string" }, "option_id": { "type": "integer" } }, "type": "object" }, "LineItemFulfillRequestSwagger": { "properties": { "id": { "type": "integer", "description": "Id of line item which belong to order", "example": 1234 }, "quantity": { "type": "number", "description": "Quantity want to fulfill, if not provide, quantity will be line item fulfillable quantity", "example": 1 } }, "type": "object" }, "LineItemFulfillment": { "properties": { "created_at": { "type": "integer" }, "fulfillment_id": { "type": "integer" }, "id": { "type": "integer" }, "line_item_id": { "type": "integer" }, "order_id": { "type": "integer" }, "quantity": { "type": "integer" }, "shop_id": { "type": "integer" }, "updated_at": { "type": "integer" } }, "type": "object" }, "LineItemShippingRate": { "properties": { "code": { "type": "string", "description": "A reference to the combined shipping method.", "example": "weight_based_47925+weight_based_47926+weight_based_47928" }, "id": { "type": "integer", "description": "The Shipping Rate Id", "example": 43531 }, "is_post_purchase": { "type": "boolean", "description": "Is post purchase" }, "price": { "type": "number", "description": "The total price of this shipping rate for a variant in the order", "example": 8 }, "title": { "type": "string", "description": "The title of the shipping method.", "example": "Small Packet International Air" }, "type": { "type": "string", "description": "The Shipping Rate Type", "example": "weight_based, price_based, item_based" }, "variant_id": { "type": "integer", "description": "The variant in which this shipping rate is applied for", "example": 123213213123 } }, "type": "object" }, "ListPagesSwaggerResponse": { "properties": { "pages": { "items": { "$ref": "#/definitions/Page" }, "type": "array" } }, "type": "object" }, "MetaField": { "properties": { "description": { "type": "string", "description": "Description" }, "key": { "type": "string", "description": "Key" }, "namespace": { "type": "string", "description": "Namespace" }, "value": { "type": "string", "description": "Value" }, "value_type": { "type": "string", "description": "Value type" } }, "type": "object" }, "MetafieldDto": { "properties": { "description": { "type": "string" }, "id": { "type": "integer", "description": "A unique numeric identifier for the meta field. Each id is unique across the ShopBase system. No two metafield will have the same id, even if they're from different shops.", "example": 632910392 }, "key": { "type": "string" }, "namespace": { "type": "string" }, "owner_id": { "type": "integer" }, "owner_resource": { "type": "string" }, "updated_at": { "type": "integer" }, "value": { "type": "object" }, "value_type": { "type": "string" } }, "type": "object" }, "NotificationSublingResponseDto": { "properties": { "category": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "NotificationWithSublingResponseDto": { "properties": { "next": { "$ref": "#/definitions/NotificationSublingResponseDto" }, "notification": { "type": "object" }, "previous": { "$ref": "#/definitions/NotificationSublingResponseDto" } }, "type": "object" }, "OrderDiscountApplicationDto": { "properties": { "allocation_method": { "type": "string", "description": "The method by which the discount application value has been allocated to entitled lines. Valid values\n* across: The value is spread across all entitled lines.\n* each: The value is applied onto every entitled line.\n* one: The value is applied onto a single line.", "example": "across" }, "code": { "type": "string", "description": "The discount code that was used to apply the discount. Available only for discount code applications.", "example": "SUMMERSALE" }, "description": { "type": "string", "description": "The description of the discount application, as defined by the merchant or the ShopBase Script. Available only for manual and script discount applications.", "example": "my scripted discount" }, "discount_type": { "type": "string", "description": "The type of the discount. Valid values\n* fixed_amount: A fixed amount discount value in the currency of the order.\n* percentage: A percentage discount value.\n* buy_x_get_y: Buy X get Y.\n* free_shipping: Free shipping for order.", "example": "fixed_amount" }, "is_applied_entire_order": { "type": "boolean", "description": "Determine discount applied for items separately or entire order. Valid values\n* true: applied entire order.\n* false: only applied for specific items.", "example": true }, "target_selection": { "type": "string", "description": "The lines on the order, of the type defined by target_type, that the discount is allocated over. Valid values\n* all: The discount is allocated onto all lines.\n* entitled: The discount is allocated only onto lines it is entitled for.\n* explicit: The discount is allocated onto explicitly selected lines.", "example": "all" }, "target_type": { "type": "string", "description": "The type of line on the order that the discount is applicable on. Valid values\n* line_item: The discount applies to line items.\n* shipping_line: The discount applies to shipping lines.", "example": "line_item" }, "title": { "type": "string", "description": "The title of the discount application, as defined by the merchant. Available only for manual discount applications.", "example": "custom discount" }, "type": { "type": "string", "description": "The discount application type. Valid values\n* manual: The discount was manually applied by the merchant (for example, by using an app or creating a draft order).\n* script: The discount was applied by a ShopBase Script.\n* discount_code: The discount was applied by a discount code.", "example": "script" }, "value": { "type": "number", "description": "The value of the discount application as a decimal. This represents the intention of the discount application. For example, if the intent was to apply a 20% discount, then the value will be 20.0. If the intent was to apply a $15 discount, then the value will be 15.0.", "example": 10 }, "value_type": { "type": "string", "description": "The type of the value. Valid values\n* fixed_amount: A fixed amount discount value in the currency of the order.\n* percentage: A percentage discount value.", "example": "fixed_amount" } }, "type": "object" }, "OrderDiscountCodeDto": { "properties": { "amount": { "type": "number", "description": "The value of the discount to be deducted from the order total. The type field determines how this value is calculated. After an order is created, this field returns the calculated amount.", "example": 30 }, "code": { "type": "string", "description": "The discount code.", "example": "SPRING30" }, "discount_type": { "type": "string", "description": "Discount type" }, "price_rule_id": { "type": "integer", "description": "Price rule id" }, "price_rule_type": { "type": "string", "description": "Price rule type" }, "scope": { "type": "string" }, "type": { "type": "string", "description": "The type of discount. Default value: `fixed_amount`", "example": "fixed_amount" } }, "type": "object" }, "OrderDto": { "properties": { "access_key": { "type": "string", "description": "Access key", "example": "68778783ad298f1c80c3bafcddeea02f" }, "additional_information": { "$ref": "#/definitions/AdditionalInformation" }, "applied_discount": { "$ref": "#/definitions/AppliedDiscount", "description": "The discount applied to the line item or the draft order object. Each draft order object can have one applied_discount object and each draft order line item can have its own applied_discount. The object has the following properties\n\u003c/br\u003e**title**: Title of the discount.\n\u003c/br\u003e**description**: Reason for the discount.\n\u003c/br\u003e**value**: The value of the discount. If the type of discount is `fixed_amount` , then it corresponds to a fixed dollar amount. If the type is `percentage`, then it corresponds to percentage.\n\u003c/br\u003e**value_type**: The type of discount. Valid values: percentage, fixed_amount.\n\u003c/br\u003e**amount**: The applied amount of the discount, based on the setting of `value_type`." }, "balance": { "type": "number", "description": "Order balance", "example": 10000 }, "billing_address": { "$ref": "#/definitions/CustomerAddressDetail", "description": "The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method. It has the following properties\n\u003c/br\u003e**address1**: The street address of the billing address.\n\u003c/br\u003e**address2**: An optional additional field for the street address of the billing address.\n\u003c/br\u003e**city**: The city, town, or village of the billing address.\n\u003c/br\u003e**company**: The company of the person associated with the billing address.\n\u003c/br\u003e**country**: The name of the country of the billing address.\n\u003c/br\u003e**country_code**: The two-letter code (ISO 3166-1 format) for the country of the billing address.\n\u003c/br\u003e**first_name**: The first name of the person associated with the payment method.\n\u003c/br\u003e**last_name**: The last name of the person associated with the payment method.\n\u003c/br\u003e**latitude**: The latitude of the billing address.\n\u003c/br\u003e**longitude**: The longitude of the billing address.\n\u003c/br\u003e**name**: The full name of the person associated with the payment method.\n\u003c/br\u003e**phone**: The phone number at the billing address.\n\u003c/br\u003e**province**: The name of the region (province, state, prefecture, …) of the billing address.\n\u003c/br\u003e**province_code**: The two-letter abbreviation of the region of the billing address.\n\u003c/br\u003e**zip**: The postal code (zip, postcode, Eircode, …) of the billing address." }, "buyer_accepts_marketing": { "type": "boolean", "description": "Whether the customer consented to receive email updates from the shop.", "example": false }, "cancel_reason": { "type": "string", "description": "The reason why the order was canceled.\n\u003c/br\u003e**customer**: The customer canceled the order.\n\u003c/br\u003e**fraud**: The order was fraudulent.\n\u003c/br\u003e**inventory**: Items in the order were not in inventory.\n\u003c/br\u003e**declined**: The payment was declined.\n\u003c/br\u003e**other**: A reason not in this list.", "example": "customer" }, "cancelled_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was canceled.", "example": "2019-04-22T11:00:00-05:00" }, "cart_token": { "type": "string", "description": "Cart token", "example": "68778783ad298f1c80c3bafcddeea02f" }, "chargeback_amount": { "type": "number", "description": "The amount of chargeback.", "example": 1000 }, "chargeback_deadline_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order's chargeback end.", "example": "2019-04-22T11:00:00-05:00" }, "chargeback_dispute_id": { "type": "string", "description": "The id of dispute" }, "chargeback_status": { "type": "string", "description": "The order's chargeback status. Valid values\n\u003c/br\u003e**null**: The order does not have any disputes.\n\u003c/br\u003e**open**: The order's dispute is open.\n\u003c/br\u003e**lost**: Merchant lost the chargeback.\n\u003c/br\u003e**won**: Merchant won the chargeback." }, "checkout_token": { "type": "string", "description": "Checkout token, unsing for checkout action", "example": "68778783ad298f1c80c3bafcddeea02f" }, "client_details": { "$ref": "#/definitions/ClientDetailsDto", "description": "Information about the browser that the customer used when they placed their order" }, "closed_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was closed.", "example": "2019-04-22T11:00:00-05:00" }, "created_at": { "type": "string", "description": "The autogenerated date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was created in ShopBase. The value for this property cannot be changed.", "example": "2019-04-22T11:00:00-05:00" }, "created_at_in_timezone": { "type": "string", "description": "The autogenerated date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was created by timezone in ShopBase. The value for this property cannot be changed.", "example": "2019-04-22T11:00:00-05:00" }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the shop currency.", "example": "USD" }, "customer_locale": { "type": "string", "description": "The two or three-letter language code, optionally followed by a region modifier.", "example": "en-CA" }, "discount_applications": { "items": { "$ref": "#/definitions/OrderDiscountApplicationDto" }, "type": "array", "description": "An ordered list of stacked discount applications." }, "discount_code": { "items": { "$ref": "#/definitions/OrderDiscountCodeDto" }, "type": "array", "description": "A list of discount codes to apply to the order." }, "email": { "type": "string", "description": "The customer's email address.", "example": "bob.norman@hostmail.com" }, "financial_status": { "type": "string", "description": "The status of payments associated with the order. Can only be set when the order is created. Valid values\n\u003c/br\u003e**pending**: The payments are pending. Payment might fail in this state. Check again to confirm whether the payments have been paid successfully.\n\u003c/br\u003e**authorized**: The payments have been authorized.\n\u003c/br\u003e**partially_paid**: The order have been partially paid.\n\u003c/br\u003e**paid**: The payments have been paid.\n\u003c/br\u003e**partially_refunded**: The payments have been partially refunded.\n\u003c/br\u003e**refunded**: The payments have been refunded.\n\u003c/br\u003e**voided**: The payments have been voided.", "example": "pending" }, "fulfillment_status": { "type": "string", "description": "The order's status in terms of fulfilled line items. Valid values\n\u003c/br\u003e**fulfilled**: Every line item in the order has been fulfilled.\n\u003c/br\u003e**null**: None of the line items in the order have been fulfilled.\n\u003c/br\u003e**partial**: At least one line item in the order has been fulfilled.\n\u003c/br\u003e**restocked**: Every line item in the order has been restocked and the order canceled.\n\u003c/br\u003e**processing**: Every line item in the order is in processing. (except Printbase plan)\n\u003c/br\u003e**processing**: Use Printbase plan - Order has been placed to supplier.\n\u003c/br\u003e**partial-processing**: At least one line item in the order is in processing." }, "fulfillments": { "items": { "$ref": "#/definitions/FulfillmentDto" }, "type": "array", "description": "List fulfillments" }, "id": { "type": "integer", "description": "Order ID", "example": 450789469 }, "is_in_post_purchase": { "type": "boolean", "description": "Whether in post purchase or not", "example": true }, "is_risk": { "type": "boolean", "description": "Is order risk" }, "line_items": { "items": { "$ref": "#/definitions/OrderLineItemDto" }, "type": "array", "description": "A list of line item objects, each containing information about an item in the order. Each object has the following properties" }, "name": { "type": "string", "description": "Order name", "example": "example name" }, "not_explicit_discount": { "type": "number", "description": "Not explicit discount", "example": 123 }, "note": { "type": "string", "description": "An optional note that a shop owner can attach to the order.", "example": "Customer changed their mind." }, "note_attributes": { "items": { "type": "\u0026{%!s(token.Pos=12336) string string}" }, "type": "array", "description": "Extra information that is added to the order. Appears in the **Additional details** section of an order details page. Each array entry must contain a hash with `name` and `value` keys." }, "order_number": { "type": "integer", "description": "The ID of the order used by the shop owner and customer. This is different from the `id` property, which is the ID of the order used by the API.", "example": 100 }, "order_status_url": { "type": "string", "description": "The URL pointing to the order status web page, if applicable.", "example": "https://checkout.shopbase.com/112233/checkouts/4207896aad57dfb159/thank_you_token?key=753621327b9e8a64789651bf221dfe35" }, "original_total_price": { "type": "number", "description": "Original total price", "example": 10001203 }, "payment_gateway": { "type": "string", "description": "Payment gateway", "example": "paypal" }, "payment_gateway_names": { "items": { "type": "string" }, "type": "array", "description": "The list of payment gateways used for the order." }, "phone": { "type": "string", "description": "The customer's phone number.", "example": "+557734881234" }, "post_purchase_timeout_at": { "type": "string", "description": "Post purchase timeout at time", "example": "2019-04-22T11:00:00-05:00" }, "previous_shipping_fee": { "type": "number", "description": "Previous shiping fee", "example": 10000 }, "processed_at": { "type": "string", "description": "Time this order be processed", "example": "2019-04-22T11:00:00-05:00" }, "referring_site": { "type": "string", "description": "The website where the customer clicked a link to the shop.", "example": "http://www.anexample.com" }, "refunds": { "items": { "$ref": "#/definitions/RefundDto" }, "type": "array", "description": "A list of refunds applied to the order. For more information, see the Refund API." }, "shipping_address": { "$ref": "#/definitions/CustomerAddressDetail", "description": "The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping." }, "shipping_discount": { "type": "number", "description": "Caculated shipping discount", "example": 2 }, "shipping_fee": { "type": "number", "description": "Caculated shipping fee", "example": 10 }, "shipping_lines": { "items": { "$ref": "#/definitions/ShippingLinesDto" }, "type": "array", "description": "An array of objects, each of which details a shipping method used" }, "shipping_tax": { "type": "number", "description": "Caculated shipping tax", "example": 2 }, "shop_id": { "type": "integer", "description": "Shop ID", "example": 123123 }, "source_name": { "type": "string", "description": "Where the order originated. Can be set only during order creation, and is not writeable afterwards. Values for ShopBase channels are protected and cannot be assigned by other API clients: web, pos, shopbase_draft_order, iphone, and android. Orders created via the API can be assigned any other string of your choice. If unspecified, then new orders are assigned the value of your app's ID.", "example": "web" }, "subtotal_price": { "type": "number", "description": "Subtotal price", "example": 123 }, "tags": { "type": "string", "description": "Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length." }, "tax_lines": { "items": { "$ref": "#/definitions/TaxLineDto" }, "type": "array", "description": "A list of tax line objects." }, "taxes_included": { "type": "boolean", "description": "Whether taxes are included in the order subtotal.", "example": true }, "token": { "type": "string", "description": "Checkout token, unsing for identifing", "example": "68778783ad298f1c80c3bafcddeea02f" }, "total_discounts": { "type": "number", "description": "Total discounts", "example": 1 }, "total_line_items_discount": { "type": "number", "description": "Total line item discount", "example": 123 }, "total_line_items_price": { "type": "number", "description": "Total line item price", "example": 123 }, "total_price": { "type": "number", "description": "Total price", "example": 100000 }, "total_quantity": { "type": "number", "description": "Total quantity", "example": 100 }, "total_shipping": { "type": "number", "description": "it's equal shipping_fee - shipping_discount + shipping_tax", "example": 10 }, "total_tax": { "type": "number", "description": "Total tax", "example": 123 }, "total_tip_received": { "type": "number", "description": "The sum of all the tips in the order in the shop currency.", "example": 4.87 }, "total_weight": { "type": "number", "description": "Total height", "example": 10 }, "updated_at": { "type": "string", "description": "Time auto generate when the order was updated", "example": "2019-04-22T11:00:00-05:00" }, "weight_unit": { "type": "string", "description": "weight_unit", "example": "Kg" } }, "type": "object" }, "OrderFulfillmentDto": { "properties": { "created_at": { "type": "integer", "description": "The date and time when the fulfillment was created. The API returns this value in ISO 8601 format." }, "date_done": { "type": "integer", "description": "The date and time when the fulfillment was fulfilled. The API returns this value in ISO 8601 format." }, "detected_tracking_company": { "type": "string", "description": "Detected tracking company" }, "first_tracking_step_at": { "type": "integer", "description": "The date and time when the first tracking step created" }, "id": { "type": "integer", "description": "The ID for the fulfillment.", "example": 255858046 }, "last_crawled_at": { "type": "integer", "description": "The date and time when the fulfillment was last crawled" }, "last_mile_tracking_company": { "type": "string", "description": "Last mile tracking company" }, "last_mile_tracking_number": { "type": "string", "description": "Last mile tracking number" }, "last_response_log": { "type": "string", "description": "Save last response of failed status" }, "last_tracking_step_at": { "type": "integer", "description": "The date and time when the last tracking step created" }, "line_items": { "items": { "$ref": "#/definitions/OrderLineItemDto" }, "type": "array" }, "name": { "type": "string", "description": "The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number.\nThe fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).", "example": "255858046" }, "notify_customer": { "type": "boolean", "description": "Whether the customer should be notified. \n If set to true, then an email will be sent when the fulfillment is created or updated. \n For orders that were initially created using the API, the default value is false.\n For all other orders, the default value is true.", "example": true }, "order_id": { "type": "integer", "description": "The unique numeric identifier for the order.", "example": 450789469 }, "send_delay_mail": { "type": "boolean", "description": "check send email delay shipping" }, "service": { "type": "string", "description": "The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number.\n The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2).", "example": "255858046" }, "shipment_status": { "type": "string", "description": "The current shipment status of the fulfillment. Valid values: \n * **attempted_delivery**: Delivery of the shipment was attempted, but unable to be completed.\n * **ready_for_pickup**: The shipment is ready for pickup at a shipping depot.\n * **confirmed**: The carrier is aware of the shipment, but hasn't received it yet. \n * **in_transit**: The shipment is being transported between shipping facilities on the way to its destination.\n * **out_for_delivery**: The shipment is being delivered to its final destination.\n * **delivered**: The shipment was successfully delivered.\n * **delayed**: The tracking status need more time to be updated (maybe cause by shipping carrier website issue), probably will be ready in 6~12 hours. \n * **failure, not_found, invalid**: Something went wrong when pulling tracking information for the shipment, such as the tracking number was invalid or the shipment was canceled.", "example": "confirmed" }, "status": { "type": "string", "description": "The status of the fulfillment. Valid values: \n * **pending**: The fulfillment is pending. \n * **open**: The fulfillment has been acknowledged by the service and is in processing. \n * **success**: The fulfillment was successful. \n * **cancelled**: The fulfillment was cancelled. \n * **error**: There was an error with the fulfillment request. \n * **failure**: he fulfillment request failed.", "example": "255858046" }, "tracking_company": { "type": "string", "description": "The name of the tracking company.", "example": "4PX" }, "tracking_number": { "type": "string", "example": "1Z2345" }, "tracking_numbers": { "items": { "type": "string" }, "type": "array", "description": "A list of tracking numbers, provided by the shipping company.", "example": [ "112345Z2345" ] }, "tracking_steps": { "type": "object" }, "tracking_url": { "type": "string", "example": "http://example.com/etracking/tracking.cgi?InquiryNumber1=1Z2345\u0026TypeOfInquiryNumber=T\u0026AcceptUPSLicenseAgreement=yes\u0026submit=Track" }, "tracking_urls": { "items": { "type": "string" }, "type": "array", "description": "The URLs of tracking pages for the fulfillment.", "example": [ "http://track-example.com/startairmail.php?code=112345Z2345" ] }, "updated_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the fulfillment was last modified." }, "variant_inventory_management": { "type": "string", "description": "The name of the inventory management service.", "example": "shopbase" } }, "type": "object" }, "OrderLineItemDiscountApplicationDto": { "properties": { "amount": { "type": "number", "description": "The discount amount allocated to the line in the shop currency." }, "discount_application_index": { "type": "integer", "description": "The index of the associated discount application in the order's discount_applications list." } }, "type": "object" }, "OrderLineItemDto": { "properties": { "discount_allocations": { "items": { "$ref": "#/definitions/OrderLineItemDiscountApplicationDto" }, "type": "array", "description": "An ordered list of amounts allocated by discount applications." }, "discount_amount": { "type": "number", "description": "Discount amount", "example": 1 }, "fulfillable_quantity": { "type": "integer", "description": "The amount available to fulfill, calculated as follows: \n `quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity`", "example": 1 }, "fulfillment_service": { "type": "string", "description": "The service provider that's fulfilling the item. Valid values: manual, or the name of the provider, such as `amazon` or `shipwire`.", "example": "amazon" }, "fulfillment_status": { "type": "string", "description": "How far along an order is in terms line items fulfilled. Valid values: null, processing, partial-processing, fulfilled, partial, and not_eligible.", "example": "fulfilled" }, "gift_card": { "type": "boolean", "description": "Whether the item is a gift card. If `true`, then the item is not taxed or considered for shipping charges." }, "image_src": { "type": "string", "description": "Image source", "example": "https://example.com/img.jpg" }, "is_post_purchase_item": { "type": "boolean", "description": "Is post purchase item" }, "item_discount_price": { "type": "number", "description": "Item discount price", "example": 20 }, "line_item_discount_amount": { "type": "number", "description": "Line item discount amount", "example": 20 }, "line_item_discount_price": { "type": "number", "description": "Line item discount price", "example": 100 }, "line_item_price": { "type": "number", "description": "Line item price", "example": 100 }, "line_item_price_after_discount": { "type": "number", "description": "Line item price after discount", "example": 20 }, "line_item_price_before_discount": { "type": "number", "description": "Line item price before discount", "example": 20 }, "line_item_price_with_explicit_discount": { "type": "number", "description": "Line item price with explicit discount", "example": 10 }, "line_item_weight": { "type": "number", "description": "Line item weight", "example": 10 }, "name": { "type": "string", "description": "The name of the product variant." }, "not_explicit_discount_price": { "type": "number", "description": "Not explitcit discount price", "example": 2 }, "order_id": { "type": "integer", "description": "Order ID", "example": 1 }, "price": { "type": "number", "description": "The price of the item before discounts have been applied in the shop currency.", "example": 225 }, "product_id": { "type": "integer", "description": "Product ID", "example": 1 }, "product_is_deleted": { "type": "boolean", "description": "The status of product of this line item" }, "product_type": { "type": "string", "description": "Product type", "example": "1" }, "properties": { "items": { "type": "\u0026{%!s(token.Pos=3634) string string}" }, "type": "array", "description": "An array of custom information for the item that has been added to the cart. Often used to provide product customization options." }, "quantity": { "type": "number", "description": "Quantity items", "example": 1000 }, "raw_price": { "type": "number", "description": "Raw price", "example": 20 }, "raw_weight": { "type": "number", "description": "Raw weight", "example": 10 }, "requires_shipping": { "type": "boolean", "description": "Whether the item requires shipping.", "example": true }, "shipping_rate": { "$ref": "#/definitions/LineItemShippingRate", "description": "Line item shipping rate" }, "sku": { "type": "string", "description": "The item's SKU (stock keeping unit).", "example": "IPOD2008GREEN" }, "tags": { "type": "string", "description": "A string of comma-separated product tags", "example": "Emotive, Flash Memory, MP3, Music" }, "tax_amount": { "type": "number", "description": "Tax amount", "example": 20 }, "tax_lines": { "items": { "$ref": "#/definitions/TaxLineDto" }, "type": "array", "description": "An array of tax line objects, each of which details a tax applicable to the order." }, "tax_rate": { "type": "number", "description": "Tax rate", "example": 1 }, "taxable": { "type": "boolean", "description": "Whether the item was taxable." }, "tip_payment_gateway": { "type": "string", "description": "The payment gateway used to tender the tip, such as shopbase_payments. Present only on tips." }, "tip_payment_method": { "type": "string", "description": "The payment method used to tender the tip, such as Visa. Present only on tips." }, "title": { "type": "string", "description": "The title of the product.", "example": "IPOD2008GREEN" }, "total_discount": { "type": "number", "description": "The total discount amount applied to this line item in the shop currency. This value is not subtracted in the line item price." }, "total_item_discount_price": { "type": "number", "description": "Total item discount price", "example": 10 }, "total_line_with_discount_price": { "type": "number", "description": "Total line with discount price", "example": 10 }, "total_tax_amount": { "type": "number", "description": "Total tax amount", "example": 10 }, "variant_id": { "type": "integer", "description": "Variant ID", "example": 1 }, "variant_title": { "type": "string", "description": "The title of the product variant.", "example": "IPOD2008GREEN" }, "vendor": { "type": "string", "description": "The name of the item's supplier." }, "weight": { "type": "number", "description": "The weight of the item", "example": 1.5 }, "weight_unit": { "type": "string", "description": "The weight unit of the item", "example": "kg" } }, "type": "object" }, "OrderRequest": { "properties": { "cart_token": { "type": "string", "description": "The ID of the cart that's associated with the order.", "example": "68778783ad298f1c80c3bafcddeea02f" }, "chargeback_deadline_at_max": { "type": "integer", "description": "Show orders last updated at or before date (format: 2019-04-22T16:15:47-04:00)." }, "chargeback_deadline_at_min": { "type": "integer", "description": "Show orders chargeback deadline at or after date (format: 2019-04-22T16:15:47-04:00)." }, "chargeback_status": { "type": "string", "description": "Filter orders by their chargeback status.\n\u003c/br\u003e**open**: Show orders that have chargeback status is open.\n\u003c/br\u003e**partial**: Show orders that their merchants submitted evidence to banks.\n\u003c/br\u003e**lost**: Show orders that their merchants lost\n\u003c/br\u003e**won**: Show orders their merchants won.", "example": "open" }, "checkout_token": { "type": "string", "example": "bd5a8aa1ecd019dd3520ff791ee3a24c" }, "created_at_max": { "type": "integer", "description": "Show orders created at or before date (format: 2019-04-22T16:15:47-04:00)." }, "created_at_min": { "type": "integer", "description": "Show orders created at or after date (format: 2019-04-22T16:15:47-04:00)." }, "customer_id": { "type": "integer", "example": 207119551 }, "delay_type": { "type": "string", "description": "Filter orders by delay type." }, "enabled_fs_pbase_profit": { "type": "boolean" }, "fields": { "items": { "type": "string" }, "type": "array", "description": "Retrieve only certain fields, specified by a comma-separated list of fields names." }, "filter_order_risk": { "type": "boolean" }, "financial_status": { "type": "string", "description": "Filter orders by their financial status.\n\u003c/br\u003e**shipped**: Show orders that have been shipped.\n\u003c/br\u003e**partial**: Show partially shipped orders.\n\u003c/br\u003e**unshipped**: Show orders that have not yet been shipped\n\u003c/br\u003e**any**: Show orders of any financial status.", "example": "any" }, "fulfillment_service": { "type": "string", "description": "Filter orders by their fulfillment service handle." }, "fulfillment_status": { "type": "string", "description": "Filter orders by their fulfillment status.\n\u003c/br\u003e**shipped**: Show orders that have been shipped.\n\u003c/br\u003e**partial**: Show partially shipped orders.\n\u003c/br\u003e**unshipped**: Show orders that have not yet been shipped.\n\u003c/br\u003e**any**: Show orders of any fulfillment status.", "example": "any" }, "ids": { "items": { "type": "integer" }, "type": "array", "description": "List of order ID" }, "ignore_shop_ids": { "items": { "type": "integer" }, "type": "array" }, "is_in_post_purchase": { "type": "boolean" }, "limit": { "type": "integer", "description": "The maximum number of results to show on a page. \n (default: 50, maximum: 250)", "example": 50 }, "min_after_hours_auto_approve": { "type": "integer" }, "min_amount_auto_approve": { "type": "integer" }, "not_product_mapping": { "type": "boolean", "description": "Filter order by line item's product not mapped." }, "offset": { "type": "integer" }, "payment_gateway": { "type": "string" }, "post_purchase_timeout_at_max": { "type": "integer" }, "product_mapping": { "type": "boolean", "description": "Filter order by line item's product mapped." }, "shop_type": { "type": "string" }, "since_id": { "type": "integer", "description": "Show orders after the specified ID." }, "tag": { "type": "string", "description": "Filter order by tag." }, "time_delay": { "type": "integer" }, "time_zone_prod": { "type": "string", "description": "offset time zone of production sbase" }, "time_zone_stripe": { "type": "string", "description": "offset time zone of stripe" }, "token": { "type": "string", "example": "68778783ad298f1c80c3bafcddeea02f" }, "tracking_number": { "type": "string", "description": "Filter order by transaction number." }, "updated_at_max": { "type": "integer", "description": "Show orders last updated at or before date (format: 2019-04-22T16:15:47-04:00)." }, "updated_at_min": { "type": "integer", "description": "Show orders last updated at or after date (format: 2019-04-22T16:15:47-04:00)." } }, "type": "object" }, "OrderShippingAddressDto": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "company": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "province": { "type": "string" }, "zip": { "type": "string" } }, "type": "object" }, "OrderSwaggerResponse": { "properties": { "order": { "$ref": "#/definitions/OrderDto" } }, "type": "object" }, "OrderTransactionSwaggerResponse": { "properties": { "transaction": { "$ref": "#/definitions/TransactionDto" } }, "type": "object" }, "OrderTransactionsSwaggerResponse": { "properties": { "transactions": { "items": { "$ref": "#/definitions/TransactionDto" }, "type": "array" } }, "type": "object" }, "OrdersSwaggerRequest": { "properties": { "chargeback_deadline_at_max": { "type": "string", "description": "Show orders chargeback deadline at or before date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "chargeback_deadline_at_min": { "type": "string", "description": "Show orders chargeback deadline at or after date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "chargeback_status": { "type": "string", "description": "Filter orders by their chargeback status, specified by a comma-separated list of statuses.\n\u003c/br\u003eAcceptable value: **open**, **submitted**, **won**, **lost**.", "example": "submitted" }, "created_at_max": { "type": "string", "description": "Show orders created at or before date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "created_at_min": { "type": "string", "description": "Show orders created at or after date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "customer_email": { "type": "string", "description": "Filter orders by their customer email.", "example": "example@shopbase.com" }, "customer_id": { "type": "integer", "description": "ID of customer", "example": 1234567 }, "fields": { "type": "string", "description": "Retrieve only certain fields, specified by a comma-separated list of fields names.", "example": "id" }, "filter_order_risk": { "type": "boolean", "description": "Filter orders by risk level.", "example": false }, "financial_status": { "type": "string", "description": "Filter orders by their financial status, specified by a comma-separated list of statuses.\n\u003c/br\u003e**authorized**: Show only authorized orders.\n\u003c/br\u003e**pending**: Show only pending orders.\n\u003c/br\u003e**paid**: Show only paid orders.\n\u003c/br\u003e**partially_paid**: Show only partially paid orders.\n\u003c/br\u003e**refunded**: Show only refunded orders.\n\u003c/br\u003e**partially_refunded**: Show only partially refunded orders.\n\u003c/br\u003e**unpaid**: Show authorized and partially paid orders.\n\u003c/br\u003e**voided**: Show only voided orders.\n\u003c/br\u003e**any**: Show orders of any financial status.", "example": "authorized,pending" }, "fulfilled_at_max": { "type": "string", "description": "Show orders fulfilled at or before date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "fulfilled_at_min": { "type": "string", "description": "Show orders fulfilled at or after date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "fulfillment_service": { "type": "string", "description": "Filter orders by their fulfillment service handle, specified by a comma-separated list of services." }, "fulfillment_status": { "type": "string", "description": "Filter orders by their fulfillment status, specified by a comma-separated list of statuses.\n\u003c/br\u003e**fulfilled**: Show orders that have been shipped (alias: **shipped**).\n\u003c/br\u003e**partial**: Show partially shipped orders.\n\u003c/br\u003e**unfulfilled**: Show orders that have not yet fulfilled or partial (alias: **unshipped**).\n\u003c/br\u003e**any**: Show orders of any fulfillment status.\n\u003c/br\u003e**restocked**: Show order that have been restocked.\n\u003c/br\u003e**processing**: Show order that in processing.\n\u003c/br\u003e**partial-processing**: Show partially processing orders.", "example": "fulfilled" }, "ids": { "items": { "type": "integer" }, "type": "array", "description": "List of order ID", "example": [ 23556, 12345 ] }, "limit": { "type": "integer", "description": "The maximum number of results to show on a page. (default: 50, maximum: 250)", "example": 50 }, "not_product_mapping": { "type": "boolean", "description": "Filter order by line item's product not mapped.", "example": false }, "not_product_name": { "type": "string", "description": "Filter orders by line item's product name which not contains.", "example": "jean" }, "not_product_sku": { "type": "string", "description": "Filter orders by line item's product sku which not contains.", "example": "esku-1234566" }, "not_product_type": { "type": "string", "description": "Filter orders by line item's product type which not contains.", "example": "cute" }, "not_product_vendor": { "type": "string", "description": "Filter orders by line item's product vendor which not contains.", "example": "example-not-vendor" }, "order_status": { "type": "string", "description": "Filter orders by their status, specified by a comma-separated list of statuses.\n\u003c/br\u003e**open**: Show only open orders.\n\u003c/br\u003e**closed**: Show only closed orders.\n\u003c/br\u003e**cancelled**: Show only canceled orders.\n\u003c/br\u003e**any**: Show orders of any status, including archived orders.", "example": "open" }, "page": { "type": "integer", "description": "Number of page.", "example": 1 }, "product_mapping": { "type": "boolean", "description": "Filter order by line item's product mapped.", "example": false }, "product_name": { "type": "string", "description": "Filter orders by line item's product name which contains.", "example": "t-shirt" }, "product_sku": { "type": "string", "description": "Filter orders by line item's product sku which contains.", "example": "sku-11223344" }, "product_type": { "type": "string", "description": "Filter orders by line item's product type which contains.", "example": "camping" }, "product_vendor": { "type": "string", "description": "Filter orders by line item's product vendor which contains.", "example": "example-vendor" }, "since_id": { "type": "integer", "description": "Show orders after the specified ID.", "example": 11102323 }, "tag": { "type": "string", "description": "Filter order by tag.", "example": "Invalid address" }, "tracking_number": { "type": "string", "description": "Filter order by transaction number.", "example": "LO123456789CN" }, "updated_at_max": { "type": "string", "description": "Show orders last updated at or before date (format: 2019-04-22T16:15:47-04:00).", "example": "2019-04-22T16:15:47-04:00" }, "updated_at_min": { "type": "string", "description": "Show orders last updated at or after date (format: 2019-04-22T16:15:47-04:00).", "example": "2019-04-22T16:15:47-04:00" } }, "type": "object" }, "OrdersSwaggerResponse": { "properties": { "orders": { "items": { "$ref": "#/definitions/OrderDto" }, "type": "array" } }, "type": "object" }, "PBaseLineItem": { "properties": { "base_cost": { "type": "number" }, "created_at": { "type": "integer" }, "id": { "type": "integer" }, "payment_fee": { "type": "number" }, "pb_order_id": { "type": "integer" }, "processing_fee": { "type": "number" }, "profit": { "type": "number" }, "sb_line_item_id": { "type": "integer" }, "sb_order_id": { "type": "integer" }, "shipping_cost": { "type": "number" }, "shop_id": { "type": "integer" }, "updated_at": { "type": "integer" } }, "type": "object" }, "PODData": { "properties": { "clipart_id": { "type": "integer" }, "clipart_type": { "type": "string" }, "is_separate_layer": { "type": "boolean" }, "layer_data": { "type": "string" }, "layers": { "items": { "$ref": "#/definitions/Layer" }, "type": "array" }, "show_type": { "type": "string" }, "sub_custom_options": { "items": { "$ref": "#/definitions/gitlab.CustomOption" }, "type": "array" } }, "type": "object" }, "Page": { "properties": { "body_html": { "type": "string", "description": "The text content of the page, complete with HTML markup.", "example": "Contact us at \u003ca href=\\\u0026quot;mailto:contact@johns-apparel.com\\\u0026quot;\u003econtact@johns-apparel.com\u003c/a\u003e" }, "handle": { "type": "string", "description": "A unique, human-friendly string for the page, generated automatically from its title. In online store themes, the Liquid templating language refers to a page by its handle.", "example": "contact-us" }, "id": { "type": "integer", "description": "The unique numeric identifier for the page.", "example": 131092082 }, "is_show_in_search": { "type": "boolean" }, "publish": { "type": "boolean", "description": "Tell whether this page is visible or hidden", "example": true }, "search_engine_image": { "type": "string" }, "search_engine_meta_description": { "type": "string", "description": "The description to display in Search Engine", "example": "Contact us at contact@johns-apparel.com" }, "search_engine_title": { "type": "string", "description": "The title to display in Search Engine", "example": "Contact us" }, "tags": { "type": "string" }, "template": { "type": "string", "description": "Template name which will be used to display. If this field is empty, default template will be used instead", "example": "contact_us" }, "title": { "type": "string", "description": "The page's title.", "example": "Contact us" } }, "type": "object" }, "PageRequestDto": { "properties": { "body_html": { "type": "string", "description": "The text content of the page, complete with HTML markup.", "example": "Contact us at \u003ca href=\\\u0026quot;mailto:contact@johns-apparel.com\\\u0026quot;\u003econtact@johns-apparel.com\u003c/a\u003e" }, "handle": { "type": "string", "description": "A unique, human-friendly string for the page, generated automatically from its title. In online store themes, the Liquid templating language refers to a page by its handle.", "example": "contact-us" }, "id": { "type": "integer", "description": "The unique numeric identifier for the page.", "example": 131092082 }, "is_show_in_search": { "type": "boolean" }, "publish": { "type": "boolean", "description": "Tell whether this page is visible or hidden", "example": true }, "search_engine_image": { "type": "string" }, "search_engine_meta_description": { "type": "string", "description": "The description to display in Search Engine", "example": "Contact us at contact@johns-apparel.com" }, "search_engine_title": { "type": "string", "description": "The title to display in Search Engine", "example": "Contact us" }, "tags": { "items": { "type": "string" }, "type": "array" }, "template": { "type": "string", "description": "Template name which will be used to display. If this field is empty, default template will be used instead", "example": "contact" }, "template_shop_id": { "type": "integer", "description": "The template shop id to check shop plusbase", "example": 1 }, "title": { "type": "string", "description": "The page's title.", "example": "Contact us" } }, "type": "object" }, "PatchProductResponseSwagger": { "properties": { "is_process_background": { "type": "boolean" }, "status": { "type": "boolean" } }, "type": "object" }, "PaymentDetailsDto": { "properties": { "avs_result_code": { "type": "string", "description": "The response code from the [address verification system](https://en.wikipedia.org/wiki/Address_Verification_System). The code is a single letter; see [this chart](http://www.emsecommerce.net/avs_cvv2_response_codes.htm) for the codes and their definitions.", "example": "123456" }, "credit_card_bin": { "type": "string", "description": "The [issuer identification number](https://en.wikipedia.org/wiki/ISO/IEC_7812) (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.", "example": "M" }, "credit_card_company": { "type": "string", "description": "The name of the company that issued the customer's credit card.", "example": "Visa" }, "credit_card_number": { "type": "string", "description": "The customer's credit card number, with most of the leading digits redacted." }, "cvv_result_code": { "type": "string", "description": "The response code from the credit card company indicating whether the customer entered the [card security code](https://en.wikipedia.org/wiki/Card_security_code), or card verification value, correctly. The code is a single letter or empty string; see [this chart](http://www.emsecommerce.net/avs_cvv2_response_codes.htm) for the codes and their definitions.", "example": "M" } }, "type": "object" }, "PaymentResponseDto": { "properties": { "x_account_id": { "type": "string", "description": "Login id of merchant in payment settings" }, "x_amount": { "type": "number", "description": "Order's amount" }, "x_currency": { "type": "string", "description": "Order's currency" }, "x_error_code": { "type": "string", "description": "An error code to be log on Shopbase" }, "x_gateway_reference": { "type": "string", "description": "Unique reference for payment issued by the payment processor." }, "x_intent": { "type": "string" }, "x_message": { "type": "string", "description": "A custom error message displayed to the customer." }, "x_reference": { "type": "string", "description": "Unique token for current checkout" }, "x_result": { "type": "string", "description": "Valid values are completed or failed" }, "x_signature": { "type": "string", "description": "Signed signature" }, "x_test": { "type": "boolean", "description": "Indicates whether or not this request should be processed in test mode (if supported)." }, "x_timestamp": { "type": "string", "description": "Time of transaction completion. UTC Time: YYYY-MM-DDTHH:MM:SSZ" }, "x_transaction_type": { "type": "TransactionType", "description": "The valid values are `capture`, `refund`, `void`, `get`.\n* **capture**: Capture the payment.\n* **refund**: Refund the payment.\n* **void**: Cancel the payment.\n* **get**: Get the payment." } }, "type": "object" }, "PhubLineItemImportRespDto": { "properties": { "id": { "type": "integer" }, "line_item_import_id": { "type": "integer" }, "product_name": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "status": { "type": "string" }, "tracking_carrier": { "type": "string" }, "tracking_data": { "$ref": "#/definitions/PhubLineItemImportTrackingDataRespDto" }, "variant_title": { "type": "string" } }, "type": "object" }, "PhubLineItemImportTrackingDataRespDto": { "properties": { "tracking_number": { "type": "string" }, "tracking_url": { "type": "string" } }, "type": "object" }, "PhubOrderImportRespDto": { "properties": { "id": { "type": "integer" }, "line_items": { "items": { "$ref": "#/definitions/PhubLineItemImportRespDto" }, "type": "array" }, "order_name": { "type": "string" }, "shipping_address": { "$ref": "#/definitions/OrderShippingAddressDto" }, "shop_id": { "type": "integer" }, "status": { "type": "string" } }, "type": "object" }, "PresentmentPrice": { "properties": { "compare_at_price": { "$ref": "#/definitions/Price", "description": "Compare at price" }, "price": { "$ref": "#/definitions/Price", "description": "Price" } }, "type": "object" }, "Price": { "properties": { "amount": { "type": "string", "description": "Amount", "example": "199.00" }, "currency_code": { "type": "string", "description": "Currency code", "example": "USD" } }, "type": "object" }, "PriceBasedShippingRateDto": { "properties": { "created_at": { "type": "integer" }, "free_ship": { "type": "boolean" }, "id": { "type": "integer" }, "max_order_subtotal": { "type": "number" }, "min_order_subtotal": { "type": "number" }, "name": { "type": "string" }, "order_subtotal_unit": { "type": "string" }, "price": { "type": "number" }, "price_unit": { "type": "string" }, "shipping_zone_id": { "type": "integer" }, "shop_id": { "type": "integer" }, "updated_at": { "type": "integer" } }, "type": "object" }, "PriceRuleDto": { "properties": { "allocation_limit": { "type": "integer" }, "allocation_method": { "type": "string", "description": "The allocation method of the price rule. Valid values: \n * **each**: The discount is applied to each of the entitled items. For example, for a price rule that takes $15 off, each entitled line item in a checkout will be discounted by $15.\n * **across**: The calculated discount amount will be applied across the entitled items. For example, for a price rule that takes $15 off, the discount will be applied across all the entitled items.\n When the value of `target_type` is `shipping_line`, then this value must be `each`." }, "created_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the price rule was created.", "example": "2019-03-14T16:09:54-04:00" }, "customer_selection": { "type": "string", "description": "The customer selection for the price rule. Valid values:\n * **all**: The price rule is valid for all customers.\n * **prerequisite**: The customer must either belong to one of the customer saved searches specified by `prerequisite_saved_search_ids` , or be one of the customers specified by ```prerequisite_customer_ids```.", "example": "prerequisite" }, "ends_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the price rule ends. Must be after starts_at.", "example": "2019-07-19T17:59:10Z" }, "entitled_collection_ids": { "items": { "type": "integer" }, "type": "array", "description": "A list of IDs of collections whose products will be eligible to the discount. It can be used only with target_type set to line_item and target_selection set to entitled. It can't be used in combination with entitled_product_ids or entitled_variant_ids.", "example": [ 4564654869, 8979761006 ] }, "entitled_country_ids": { "items": { "type": "integer" }, "type": "array", "description": "A list of IDs of shipping countries that will be entitled to the discount. It can be used only with target_type set to shipping_line and target_selection set to entitled.", "example": [ 6798798798, 5675765905 ] }, "entitled_product_ids": { "items": { "type": "integer" }, "type": "array", "description": "A list of IDs of products that will be entitled to the discount. It can be used only with `target_type` set to `line_item` and `target_selection` set to `entitled`. ``` If a product variant is included in entitled_variant_ids, then entitled_product_ids can't include the ID of the product associated with that variant.```", "example": [ 7897397755, 42382368242 ] }, "entitled_variant_ids": { "items": { "type": "integer" }, "type": "array", "description": "A list of IDs of product variants that will be entitled to the discount. It can be used only with target_type set to line_item and target_selection set to entitled." }, "id": { "type": "integer", "description": "The ID for the price rule.", "example": 9808080986 }, "maximum_discount_amount": { "type": "number", "description": "maximum discount use" }, "once_per_customer": { "type": "boolean", "description": "Whether the generated discount code will be valid only for a single use per customer. This is tracked using customer ID.", "example": true }, "prerequisite_collection_ids": { "items": { "type": "integer" }, "type": "array", "description": "List of collection ids that will be a prerequisites for a Buy X Get Y discount. The entitled_collection_ids can be used only with: \n * target_type set to line_item, \n * target_selection set to entitled, \n * allocation_method set to each and \n * prerequisite_to_entitlement_quantity_ratio defined. \n Cannot be used in combination with prerequisite_product_ids or prerequisite_variant_ids.", "example": [ 384028349005, 3492039843 ] }, "prerequisite_customer_ids": { "items": { "type": "integer" }, "type": "array", "description": "List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The entitled_variant_ids can be used only with: \n * target_type set to line_item, \n * target_selection set to entitled, \n * allocation_method set to each and \n * prerequisite_to_entitlement_quantity_ratio defined.", "example": [ 384028349005, 3492039843 ] }, "prerequisite_emails": { "items": { "type": "string" }, "type": "array", "description": "List of emails that will be a prerequisite for a discount", "example": [ "hoaipiu@gmail.com", "tieumapmap@gmail.com", "traxanh@mtp.com" ] }, "prerequisite_product_ids": { "items": { "type": "integer" }, "type": "array", "description": "List of product ids that will be a prerequisites for a Buy X Get Y type discount. The prerequisite_product_ids can be used only with: \n * target_type set to line_item, \n * target_selection set to entitled, \n * allocation_method set to each and \n * prerequisite_to_entitlement_quantity_ratio defined." }, "prerequisite_quantity_range": { "$ref": "#/definitions/QuantityRange", "description": "The minimum number of items for the price rule to be applicable. It has the following property: \n * **greater_than_or_equal_to**: The quantity of an entitled cart item must be greater than or equal to this value.\n" }, "prerequisite_shipping_price_range": { "$ref": "#/definitions/ShippingPriceRange", "description": "The maximum shipping price for the price rule to be applicable. It has the following property: * **less_than_or_equal_to**: The shipping price must be less than or equal to this value.\n" }, "prerequisite_subtotal_range": { "$ref": "#/definitions/SubtotalRange", "description": "The minimum subtotal for the price rule to be applicable. It has the following property: \n * **greater_than_or_equal_to**: The subtotal of the entitled cart items must be greater than or equal to this value for the discount to apply." }, "prerequisite_to_entitlement_quantity_ratio": { "$ref": "#/definitions/ToEntitlementQuantityRatio", "description": "Buy/Get ratio for a Buy X Get Y discount. prerequisite_quantity defines the necessary 'buy' quantity and entitled_quantity the offered 'get' quantity. The prerequisite_to_entitlement_quantity_ratio can be used only with:\n * value_type set to percentage,\n * target_type set to line_item, \n * target_selection set to entitled, \n * allocation_method set to each" }, "prerequisite_variant_ids": { "items": { "type": "integer" }, "type": "array", "description": "List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The entitled_variant_ids can be used only with: \n * target_type set to line_item, \n * target_selection set to entitled, \n * allocation_method set to each and \n * prerequisite_to_entitlement_quantity_ratio defined.", "example": [ 384028349005, 3492039843 ] }, "quota_per_customer": { "type": "integer", "description": "Limit use a customer" }, "quota_per_store": { "type": "integer", "description": "Limit use a store" }, "shop_id": { "type": "integer" }, "starts_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the price rule starts.", "example": "2019-04-19T17:59:10Z" }, "status": { "type": "string" }, "target_selection": { "type": "string", "description": "The target selection method of the price rule. Valid values: \n * **all**: The price rule applies the discount to all line items in the checkout. \n * **entitled**: The price rule applies the discount to selected entitlements only.\n", "example": "entitled" }, "target_type": { "type": "string", "description": "The target type that the price rule applies to. Valid values: \n * **line_item**: The price rule applies to the cart's line items.\n * **shipping_line**: The price rule applies to the cart's shipping lines.\n", "example": "line_item" }, "title": { "type": "string", "description": "The title of the price rule. This is used by the ShopBase admin search to retrieve discounts. It is also displayed on the **Discounts** page of the ShopBase admin for bulk discounts.\n For non-bulk discounts, the discount code is displayed on the admin.\n For a consistent search experience, use the same value for title as the code property of the associated discount code.", "example": "SUMMERSALE10OFF" }, "total_redemption": { "type": "integer", "description": "Total amount used discount" }, "total_sale_count": { "type": "number", "description": "Total discount sale count" }, "type": { "type": "string" }, "updated_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the price rule was updated.", "example": "2019-03-14T16:09:54-04:00" }, "usage_count": { "type": "integer" }, "usage_limit": { "type": "integer", "description": "The maximum number of times the price rule can be used, per discount code.", "example": 10 }, "value": { "type": "number", "description": "The value of the price rule. If if the value of target_type is shipping_line, then only -100 is accepted. The value must be negative.", "example": -60 }, "value_type": { "type": "string", "description": "The value type of the price rule. Valid values: \n * **fixed_amount**: Applies a discount of value as a unit of the store's currency. For example, if value is -30 and the store's currency is USD, then $30 USD is deducted when the discount is applied. \n * **percentage**: Applies a percentage discount of value. For example, if value is -30, then 30% will be deducted when the discount is applied. \n If target_type is shipping_line, then only percentage is accepted.", "example": "fixed_amount" } }, "type": "object" }, "PriceRuleSwaggerResponse": { "properties": { "price_rule": { "$ref": "#/definitions/PriceRuleDto" } }, "type": "object" }, "PriceRulesRequest": { "properties": { "created_at_max": { "type": "integer" }, "created_at_min": { "type": "integer" }, "ends_at_max": { "type": "integer" }, "ends_at_min": { "type": "integer" }, "fields": { "items": { "type": "string" }, "type": "array" }, "filter": { "type": "string" }, "ids": { "items": { "type": "integer" }, "type": "array" }, "ignore_id": { "type": "integer" }, "limit": { "type": "integer" }, "no_prerequisite": { "type": "boolean" }, "page": { "type": "integer" }, "shop_id": { "type": "integer" }, "since_id": { "type": "integer" }, "sort_by": { "type": "string" }, "starts_at_max": { "type": "integer" }, "starts_at_min": { "type": "integer" }, "target_selection": { "type": "string" }, "times_used": { "type": "integer" }, "title": { "type": "string" }, "type": { "type": "string" }, "updated_at_max": { "type": "integer" }, "updated_at_min": { "type": "integer" } }, "type": "object" }, "PriceRulesResponse": { "properties": { "price_rules": { "items": { "$ref": "#/definitions/PriceRuleDto" }, "type": "array" } }, "type": "object" }, "ProductDeleteMultiSwaggerRequest": { "properties": { "exclude_ids": { "items": { "type": "integer" }, "type": "array", "description": "This field will exclude ids of product that want to keep.", "example": [ 1, 2, 3 ] }, "type": { "type": "string", "description": "Use type for want delete all product with value default is all.", "example": "all" } }, "type": "object" }, "ProductDeleteMultiSwaggerResponse": { "properties": { "status": { "type": "string", "description": "Message for delete success.", "example": "delete success" } }, "type": "object" }, "ProductDto": { "properties": { "body_html": { "type": "string", "description": "A description of the product. Supports HTML formatting.", "example": "\u003cp\u003eIt's the small iPod with a big idea: Video.\u003cp\u003e" }, "can_preview": { "type": "boolean", "description": "This product can be previewed by personalize tool or not" }, "collection_ids": { "items": { "type": "integer" }, "type": "array" }, "created_at": { "type": "integer", "description": "Created at time" }, "custom_options": { "items": { "$ref": "#/definitions/dto.CustomOption" }, "type": "array" }, "display_options": { "$ref": "#/definitions/DisplayOptions" }, "fulfillment_services": { "items": { "$ref": "#/definitions/FulfillmentService" }, "type": "array" }, "handle": { "type": "string", "description": "A unique human-friendly string for the product. Automatically generated from the product's `title`. Used by the Liquid templating language to refer to objects.", "example": "ipod-nano-8gb" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 }, "image": { "$ref": "#/definitions/gitlab.ProductImage" }, "images": { "items": { "$ref": "#/definitions/gitlab.ProductImage" }, "type": "array" }, "metafields_global_description_tag": { "type": "string", "description": "A description of the product used for SEO purposes. Generally added to the \u003cmeta name='description'\u003e tag.", "example": "It's the small iPod with a big idea: Video." }, "metafields_global_title_tag": { "type": "string", "description": "The name of the product used for SEO purposes. Generally added to the \u003cmeta name='title'\u003e tag.", "example": "IPod Nano - White, 8GB" }, "options": { "items": { "$ref": "#/definitions/dto.ProductOption" }, "type": "array" }, "product_availability": { "type": "integer", "description": "1. Available in all channels\n2. Hide from the sitemap.txt\n3. Hide from online store listing pages (homepage, collection pages, search page,...)\n0. Hide from all channels", "example": 7 }, "product_type": { "type": "string", "description": "A categorization for the product used for filtering and searching products.", "example": "Cult Products" }, "published": { "type": "boolean", "description": "Published or not", "example": true }, "published_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel." }, "tags": { "type": "string", "description": "A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.", "example": "Emotive, Flash Memory, MP3, Music" }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "updated_at": { "type": "integer", "description": "Updated at time" }, "variants": { "items": { "$ref": "#/definitions/ProductVariantRequestWithOptionValueDto" }, "type": "array" }, "vendor": { "type": "string", "description": "The name of the product's vendor.", "example": "Apple" } }, "type": "object" }, "ProductDtoSwagger": { "properties": { "body_html": { "type": "string", "description": "A description of the product. Supports HTML formatting.", "example": "\u003cp\u003eIt's the small iPod with a big idea: Video.\u003cp\u003e" }, "custom_options": { "items": { "$ref": "#/definitions/dto.CustomOption" }, "type": "array", "description": "List of custom options" }, "display_options": { "$ref": "#/definitions/DisplayOptions", "description": "List of display options" }, "handle": { "type": "string", "description": "A unique human-friendly string for the product. Automatically generated from the product's `title`. Used by the Liquid templating language to refer to objects.", "example": "ipod-nano-8gb" }, "images": { "items": { "$ref": "#/definitions/dto.ImageRequest" }, "type": "array", "description": "List of images" }, "metafields_global_description_tag": { "type": "string", "description": "A description of the product used for SEO purposes. Generally added to the \u003cmeta name='description'\u003e tag.", "example": "It's the small iPod with a big idea: Video." }, "metafields_global_title_tag": { "type": "string", "description": "The name of the product used for SEO purposes. Generally added to the \u003cmeta name='title'\u003e tag.", "example": "IPod Nano - White, 8GB" }, "options": { "items": { "$ref": "#/definitions/dto.ProductOption" }, "type": "array", "description": "List of options" }, "product_availability": { "type": "integer", "description": "1. Available in all channels\n2. Hide from the sitemap.txt\n3. Hide from online store listing pages (homepage, collection pages, search page,...)\n0. Hide from all channels", "example": 7 }, "product_type": { "type": "string", "description": "A categorization for the product used for filtering and searching products.", "example": "Cult Products" }, "published": { "type": "boolean", "description": "Published or not", "example": true }, "published_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel." }, "tags": { "type": "string", "description": "A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.", "example": "Emotive, Flash Memory, MP3, Music" }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "variants": { "items": { "$ref": "#/definitions/ProductVariantRequestWithOptionValueDtoSwagger" }, "type": "array", "description": "List of variants" }, "vendor": { "type": "string", "description": "The name of the product's vendor.", "example": "Apple" } }, "type": "object" }, "ProductDtoTransformRequestUpdateProduct": { "properties": { "body_html": { "type": "string", "description": "A description of the product. Supports HTML formatting.", "example": "\u003cp\u003eIt's the small iPod with a big idea: Video.\u003cp\u003e" }, "can_preview": { "type": "boolean", "description": "This product can be previewed by personalize tool or not" }, "created_at": { "type": "integer", "description": "Created at time" }, "custom_options": { "items": { "$ref": "#/definitions/dto.CustomOption" }, "type": "array", "description": "List of custom options" }, "delete_image_ids": { "items": { "type": "integer" }, "type": "array", "description": "List image you want to delete", "example": [ 123123, 434343 ] }, "display_options": { "$ref": "#/definitions/DisplayOptions", "description": "List of display options" }, "handle": { "type": "string", "description": "A unique human-friendly string for the product. Automatically generated from the product's `title`. Used by the Liquid templating language to refer to objects.", "example": "ipod-nano-8gb" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 }, "image": { "$ref": "#/definitions/ProductImageWithAttachment", "description": "An image we want to insert/update" }, "images": { "items": { "$ref": "#/definitions/ProductImageWithAttachment" }, "type": "array", "description": "A list of image we want to insert/update" }, "metafields_global_description_tag": { "type": "string", "description": "A description of the product used for SEO purposes. Generally added to the \u003cmeta name='description'\u003e tag.", "example": "It's the small iPod with a big idea: Video." }, "metafields_global_title_tag": { "type": "string", "description": "The name of the product used for SEO purposes. Generally added to the \u003cmeta name='title'\u003e tag.", "example": "IPod Nano - White, 8GB" }, "options": { "items": { "$ref": "#/definitions/dto.ProductOption" }, "type": "array", "description": "List of product option set with options" }, "product_availability": { "type": "integer", "description": "1. Available in all channels\n2. Hide from the sitemap.txt\n3. Hide from online store listing pages (homepage, collection pages, search page,...)\n0. Hide from all channels", "example": 7 }, "product_type": { "type": "string", "description": "A categorization for the product used for filtering and searching products.", "example": "Cult Products" }, "published": { "type": "boolean", "description": "Published or not", "example": true }, "published_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel." }, "tags": { "type": "string", "description": "A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.", "example": "Emotive, Flash Memory, MP3, Music" }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "updated_at": { "type": "integer", "description": "Updated at time" }, "variants": { "items": { "$ref": "#/definitions/dto.ProductVariantRequestWithOptionValue" }, "type": "array", "description": "A list of variant with option that we want to update" }, "vendor": { "type": "string", "description": "The name of the product's vendor.", "example": "Apple" } }, "type": "object" }, "ProductGetTypesSwaggerResponse": { "properties": { "types": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ProductGetVendorsSwaggerResponse": { "properties": { "vendors": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ProductImageDTO": { "properties": { "alt": { "type": "string", "example": "new alt tag content" }, "created_at": { "type": "string", "example": "hidden" }, "height": { "type": "integer", "description": "Height dimension of the image which is determined on upload.", "example": 480 }, "id": { "type": "integer", "description": "A unique numeric identifier for the product image.", "example": 850703190 }, "old_image_id": { "type": "integer" }, "position": { "type": "integer", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": 1 }, "product_id": { "type": "integer", "description": "The id of the product associated with the image.", "example": 632910392 }, "src": { "type": "string", "description": "Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).", "example": "https://scn-dev.s3.amazonaws.com/uSKbqtidCG-1553937818736606000.jpg" }, "updated_at": { "type": "string", "example": "hidden" }, "updated_source": { "type": "string", "example": "hidden" }, "variant_ids": { "items": { "type": "integer" }, "type": "array", "description": "An array of variant ids associated with the image.", "example": [ 808950810 ] }, "width": { "type": "integer", "description": "Width dimension of the image which is determined on upload.", "example": 640 } }, "type": "object" }, "ProductImageRequest": { "properties": { "image": { "$ref": "#/definitions/product_image_handlers.ImageRequest" } }, "type": "object" }, "ProductImageWithAttachment": { "properties": { "alt_text": { "type": "string", "description": "The text in alt property of image", "example": "ipod-nano-xin" }, "attachment": { "type": "string", "description": "Base64 string of image", "example": "R0lGODlhbgCMAPf/APbr48VySrxTO7IgKt2qmKQdJeK8lsFjROG5p/nz7Zg3\\nMNmnd7Q1MLNVS9GId71hSJMZIuzTu4UtKbeEeakhKMl8U8WYjfr18YQaIbAf\\nKKwhKdKzqpQtLebFortOOejKrOjZ1Mt7aMNpVbAqLLV7bsNqR+3WwMqEWenN\\nsZYxL/Ddy/Pm2e7ZxLlUQrIjNPXp3bU5MbhENbEtLtqhj5ZQTfHh0bMxL7Ip\\nNsNyUYkZIrZJPcqGdYIUHb5aPKkeJnoUHd2yiJkiLKYiKLRFOsyJXKVDO8up\\nosFaS+TBnK4kKti5sNaYg/z49aqYl5kqLrljUtORfMOlo/36+H4ZH8yDYq0f\\nKKFYTaU9MrY8MrZBNXwXHpgaIdGVYu/byLZNP9SaZLIyOuXCtHkpJst+Wpcm\\nLMyCa8BfP9GMb9KQdPDd1PPk1sd5VP79/L5dQZ0bI9+ymqssK9WcfIoXHdzG\\nxdWWfteib79lSr1YP86MYurQxKdcUKdMQr5ZSfPs6YEZH8uhl4oWIenMuurQ\\nttmejaqoqsqBVaAcJLlJN5kvMLlZRMNsSL5fRak0LbdQQMVvSPjw6cJnRpkf\\nKtmjhvfu5cJtT7IuOMVvWLY/M/37+o0YH9ibhtSYdObErc6HarM9NnYSGNGR\\navLi09unje3WyeO8rsVrT7tdRtK3uffu6NWeaL9pTJIjJrM4NPbx8cdyX7M7\\nPYYVHu7j4KgoNJAYIKtkV5o9MsOcldicis+RYNutfrhFOZ0hJbqinZ8bI8h5\\nUObFuOfItJsfJrJfUOfIqc+PXqQtK8RnSbA4Mcd3Tm0SGbpXQ8aqp7RLNs+s\\novHfzpVhV9iggMd1TLtbRKUdKXEQFsd4XrZRPLIgMZUeJ+jKvrAlK6AhJ65A\\nMpMpKuC3j5obIsRwS7hAN8l/YtvDvnYXHbAoLI47SIUsOMenorF4gO/m4+fH\\npo4vLZ8oKMukqp0cJbhVSMV2UuPR0bAfMLIrLrg/OcJwT8h+Vt+wn8eurLlh\\nQrIfKHQOHHQOHf///////yH5BAEAAP8ALAAAAABuAIwAAAj/AP8JHDhQXjpz\\n/PopXNiPn0OHDRMmbKhQIsOJFS1SxAhxI8SHFzVeDBnx48iNBAeeOkcxokeX\\nFRdOnAlSokaaLXNujJkxo8iYHRkKtWkzZSsaOXkAWsoUECynsHgoqEW1qtVa\\nU7Mq2Mq1K9cUW8GKTUG2rNkUHNByWMuWLdWva7t1W7UKG4S7eO/ycEhQHgaK\\nsL4VGGyocGE3br5929KuxQFFkEtIlgypsuUDmDMfWGRmUZvPoEHfGU36jgDT\\nLQSoVt3IQ2sPsL0IUNZGlZ0H0lo00jEkCytWMspdGzBgn/F9EBIWnKIQlqHB\\nhA0bQpx48Z7UAkoEcMTdUeTJJSxf/4akOTNnzqHb3GkjrUdp0gKwq77jWdod\\nO7dNKWvhRUcWT6zYQI82xB03AAQNCdTKX/xAAB10hfVCnRtbVIhIAy14oJoZ\\nAXS4XXfdQaYIeOGJRx555Z1nRnrqqUeaMtIYY8dmn7Vg2yK57TYEgAzIQGBx\\nxyXHj0A0OOTggxFKSN1iWwTTAIYanpYdMtFE4+GVIHrn3XeUmVhZeWiIMoOY\\nnVQDGiTgKALJjIssIsADt0mjjI6+AXcDgQYi2M8/7ijEwzRIFmBIL9NVV+EW\\nVzyZ4Wqj9RBABchQWeWkV3aY5ZYjjgieeKL446mnjxwAiZVpliAjZqblt19/\\n/7HCwIAFGv+X3J4s9fMckoYhphiTQTwJ5Wqn9dDDAWuMUUEFviTrS6STVlmp\\npVmKqCkOn34aB6TIBAAOJeHZAYl6ptixSCL8edGbq8HFeqBDcygEyIOCGqYk\\nkxUW4euiq7knbA/gUDHGv//ec2wFayQbaQWinOCslVhmSUq1/gCDLJXacgtJ\\nCYu4J66cjbAKoA3CxapnOgm9g+ughdK7xYX3Rinlvj2YYcYanVBBhTg2Axzw\\nG4/4k4bBzDZbKRUQP1LIsRSX6sgBZtwhzQP68ccbj7AWty4/5igEoaC9dK3r\\noVtgs4evvzKqb8wyQ0JFJzXXbDMVcQBQLTDGVmCssstKGs09oPT/jQcRoBw9\\nMamKgEOeeg/gqBtvdVZSDnHFIQgRD4RxXWhiYEOQKNn4zncHzDIzHc0ZpHdy\\nRicIQOypKDf7q3Pd96ABzSab+E1EIYIvS2o0ijA92gPZiCB1qwL+iJxL78Z7\\n2NeHQrAK2YrCZva+bcgcujFUQIEG6WigonoCdLT9tr9UbIIAMMCEkkYacvvT\\nxSgsBPKGJKBEAw4yjhx+hyn+PAJFfztyVdWOt5B3RehyimneFuwFvQxFyTSf\\n25f1zCAqSFACDXTQ3gwSoDoElI5tZyBAINqnuhJ+Kg9vOIOaVnSHT5ECHucK\\n0OMiBxJAPCdXmGseBLoBvei5rFEStB5m/yBhjFJUIw50oIMoLvCpFRAADduj\\nwxvUYMIqmvARCBiDeiwRBk+lQQTEq5qQ3CWdJSkGAlu4y9h66EBgAbF6QhSV\\nMUpQilKcQRNLwIenfpFEJebBioC0ohrQQJ8QhMIfSwhgj2YouYTYUEmGqhBe\\nFNBDH5otgmgLnRyLWMdq0GEGCMCHJjSBjzQE8pSChMLTCJBI4pXDBeuiiA1T\\nprK7PK+SUPphsIQ1wSEag5OUKIUlyiAmAowClci0YizKILUAFi+WDQEEJOmF\\nxlnMYnOVbOP0gkjBTdZRmDiwhCuywcRkmtOEpHjC1DzBABto4xqN5AcgdEXN\\nNO4Ql0+CB2xctv9LM2SSgpXhZB0t0QlT+iMUkzinQquFihD452P0gGdGAPGN\\nHKYxjbOAwBpxqU9+ApGXQgyoQDWRgASwoAMGMMAHDrnQhc5AkQPSU0NgYVF7\\nQmAWKcBnPvc5HwGcbUVxJCInEfACQXQACUhFQkqRwAIOttScv9ABO21wA8k1\\np5Z3mYXYdNqAjvLzbHDUpFCNIQoUdGAdHUhrUg2gVAOg4AXmvEAaOPEGaCCA\\nAASQxBtIYYIq5kEHAaKHVfsRGB3eNBPYxKdXGVWGUnAzdOSxgyg+MIxhoDWt\\nal3rUlXABEBeYBQIiMMm0AAKPBBAE1A4nTjWEIAzvGEFqsvDEHqEjZj/wMKw\\n1rwlVxerGkv4AxVoAOkEmXGMOKDgA8i1LFrRioSjKrWtKRVEQlXHBBSKQhLQ\\nEG3tCHCLJaSWClD0zgHO8LBqDeIYNsDGTG4ryZtak4G7lZ6G2sBSfyCAaTK7\\nAzfgQIEzoOC/yKVsZS+bWeim1BsdqEG10oCANxDgDZwIRHa3O4hbaA91nlKB\\nKA7QBhHo0VPwCFBtAdNea86CZVztKk8FUN5PjQIHxKWABihQBkHY+L/HTa5l\\nMetcAxvAG94wQAQAkA1SIIAUBvUHdkVLgBkMwrvkPSEkVtSCJ/yCAJ5gZ20l\\nwgObziITGk3xTqUHhWoxYQVdAIYINMBmO0TA/8aCwHGOBbwOAvc4pXj2RieY\\nIY69ttgfpJBEHOLQ5ArTAQ2SaPAb4lAC33XsoaxYhUx4kFVrZoKSYlYxbOzg\\nPX8kAM1d6AILOuEDDQzBBCaIwJvhjOMAU7bOmE0qdMUhhFozQhVxiMWnuiAJ\\nQTfZyahFQydWGwA1cbiZAJL0Qiht6UzoVsxetUQaJhEKZzhDBdh+A5s9AQxU\\nq3rVN241ne0sa1rXWgjbqLUd3uqPUYhCFNDAxwzm3d3vjgF/vTvAHegUaYbw\\nwMSZyAR8oX0I2BwiC2eoQQ2srYJA6IDNb2ABqr39bVYDWMfkRgIVzs1xdEOD\\nCjhQ4nXlPe9BaOLQNf+rRjQc0eg2DM8TyvZTs3mY6Xwy4xI2YLMGdIAAhTvD\\nFWzuhKhZIHGKq9riF381rDtQho53/Bjpboc1OiEJktMbtaplrbHboCOYT9rS\\nOdhopocwgiRowOw6L0MNCKCBKjwA26IW9cRTXfE4i1vAlpUEHJze8XTXehvc\\n2AQ05k3vDHaiDGNYeaPNoAzGxbwf/86EHDCd4kbsyBMySII2NH92nevg4TbI\\nA7ZVEGqiF93ocLb7nIdhgGMIoROW4Dvft2GHOqQiDoM3+YWJnT8O7yYL3fgI\\nDwK+CrFX0lwBctUxtLH55qNd5xkYxMKvDffSn/7b4L47JYQgjnW0XvZOv0L/\\nKmz/BS5sIg5QvtkavDPlO/Am+FzOBCBqgU8veEJA9LCBDRjQznIw3/lJEIBs\\n5gqhUIALN3rWR3QTh31IFwcUkAiV1QEOCH4ddw8LkAqpUH5cgAtnIGzikHgs\\nxzSW1w3+Jgc0Bz32Rw8DoA3lQA8yIAP6xwoj4H//B4BJYAOjoAZqYIDWRn0J\\nuIB1Z3fHQAGdgHeJQIEcxwwLQH5csIHEQARE4C9aRx49oAPw5ydyIHaANUPE\\nwXwtmH/6Vw5iKIb/F4DaoAGisAIroIM7WG0MR3pDd3qoJwjVQAEUAAdvEGAG\\nsHcUgITFgAtLmIFNiAtQeAInMAa+UGwiyAEW8QMc//AkgKUNx7EPkLOCLOiC\\nNiADIzCDY0iDm2cHLxCKbNiGPueDcVh02McJ/GWHjfABxyUJdigEfUiB+pAL\\ndVAHX1B+uPCERHAChSAw8QAOHMaIE6EF3MAKkjiJxlGJljgC+UcPm7iJnch8\\nDJAHoRiKaqiDBRgK01d9LDB0QFiHdmiH1YACSDCE4ziLsscIdRCIGriLhfiL\\naxAPOKAKtbARPFAFQKKMywg5XuiC9ACN0TiNOwAAAHCNL5CN2siN3QiHcYhq\\nwCAD6WiHomAJEzmO4LcGueCOG4gLf2OIAjOPOHCPEEFT/KiMzKgNLigDABmN\\nnKgL02aQB3mNCkmKB+iNCv+IBjI2Y+O4ihcZi063DcywkReYi04Yj/ewBmuA\\nAyRYEbAAAVVwkv3oj9rwgizJks4okCMwCI+ACqgwCQaJkGq4hm3IjW8YakPn\\nCWxmhzz5kxfJd3iwkUx4lL0ojw/QlAnxlG4glQYCOStplS8YkJuoCwnwCIY5\\nCYgZljRJlqTYg9WnbTq3lm3plrGojrVWixuJgRpIDB95AgLTCCRYkjeVAXw5\\nlfqXiVa5ks64QSVlmF8JljO5mAtplj4IdJE5YzpHmenYcXCwAHKJi7rIi74Y\\nD7oQms1xU71QmpQ4AOVwmvoHmAH5ABcwna3pmompmAnJmDzIcGp5m2upmxMp\\ni+f/Zg9AIJeCeJSG+ACHAH8OwWyzoJyUCIOnCYOAKQP4wATTeQElVZio8AiI\\nCZtiSZbbuHAIUAXemZu5CZ4YyQ250KAXeJ6c2YsCYIUYwWyZUADK6QoEwAfO\\nOZ8yoANSwAT4SZ37eZjXGZtjOZshoAFQ8HAHOo6TCZ5CgAfluYS4OIhPGA8C\\n4AXBtxBP+WXvWZrZ4ClhYAkdmokzgAkhKqIjqp+GaaIyGaAL+XDOEAEueqC4\\nGaNuKQTWAAQ1OpceCQktcAgcYFuHJQc+wJfhADFpsAPhcJpewAZKKgVL2qTV\\n2ZUnKptqMApJ8ADVZqVYKpkKaodwEAflaYvAuYFE4HIe/8CIEWGhchCkJ7kE\\nJQQAHGoDZcYGckqnTGqnhWmiALqYS5AEdGCAVmqgBvqiMqagquANX3qe8cCo\\njpqX1iQHsAALaWogx5FkEBMO7URCmjqnTJqfJQql2LkClpAEwNCGahABapmq\\nqqqgjAAE3uCgTFgC6tEIZVoRzCYHckBpJ+kBJoQA+xcCqrOpdeqpT/qf2JkF\\nSQAPOdiGLoqq0QqeVOCqDUp+RMBh+7atDgELX+atPJCPKOkAJmQJ7fRH54oJ\\nc7qk+amfn+qfsAkAKqB5SeAFo7CGwBCo3smWlMkMQPaqyAAJi2AaKTBpECB5\\nUdFlKJk6qoMK/McHVsSwdFqnxP9aUv3JrgRghhcbCCswqp0XmdAamTtJmXHg\\nqjWaCmqCIwJwsg/RrSvLA6R5HDIAAyJAAJ3mKQQAAwxwC4Akp8Iqog9bna+5\\nA2V4g+kUgM/HZlUwtB2rparwYzWKB/nzAG3QtBVaq1HxA5+wl8cBA1iABTCg\\nCyGgsK7Af1lrReiariTKn6ggAmTIfDfIAJuntt7pth2bjnAABHKbC74ADi13\\nByfLrQG7sp/AA8dBD4EruIILAy0ABboAA66ATMHKqcMKsZ/aCNMouWrbu2vb\\nthw7kdUgt3VgP41WsinwEPzwb7NgqzzwA3xrCMYBuKu7ujBwvTBAAOYEtrbr\\nqQkwg5z/GLmVa7GWy7EJmo7ccGB4gAxp8i3SMLoNEXnOywOf8AmwsA/aUL3V\\ni726QELJtLi3W1ICWQ7SGLm+67tCi6UeSwGb8GOFkC1L+74uAbAq+7z1Sw0F\\nwACXcAmBy8H6O7sLxb22O52k4IwD2Yk0SL69a763KWOJgAQLACnFBgl267Qy\\nV8H0+wnUgAEb3MMbrL/a+1SaWrNMSgpYqZUEPIY1qMICyMJtCQSB4wv2czjw\\nC3mla8E6nAzcEA4+jAU/HLiJG8IAbMRW6ZLgq8S8e8BOPGM4cDtSDLqboQD4\\neMV8m8VXkAV47MMeDMJP9SmLiw82oAOpicThm8IHXL6BSgEn/4AHhbAsaRLH\\nMSG/e3vBjojHWRADeowFg9DHEMO9DmADDjAK1ZCaLknAhZzGaoyl3IALXHAC\\nMry0cjwR8juwz0sN1OBs3HDJlpwFl8DLvMrJnqKpUADKIUoKD1DGpVzAZ3vI\\nWKoIxNDKr0yysRy/dKzDP3BTChADunzJlxAOygDMJkQANlAGmMCk+CDI0KiV\\nBYzGh9zEOmcDRPCEjEwlI3IACtARkmzB1JBRs9AN3KDN2mzJZQDOJRQGNmAH\\nDSuiyhCYL2jGKIzKCMxmdwCFRMDIb9xo07y8V1y/14wXVxADIA3QWRDEBF0t\\nBi0CAOwKgDkCmmjGpzy+anwPvbjIJ//gyBitvLNswRmVVewQ0iL9yyVt0PVA\\nAIsLBfVJytK4zuXQzknADIZoiIVABNEsx8vWvN/6vJRmU6vw0T4tsyWtOvxn\\nA+EABQCgpID8gqh5lQ6dxGR4yIrgi78o01MdyVY9sJ+QCd+ARlmVzT490F8N\\nMTEQ1gwQDiGwPh260i2dzJ3Yu8eAO/fw2BVwD408w7UAEv9mqyubQBe1Q/98\\nCCA9A38NMSLAf4JtAyFw2Gnd0Il9wmKotm0Q10o5j41svFQtc/M7CwmU1/ZU\\nC559CLrwC6FdLSFA2sR9pB5anw4dvlUZDyE5j/SINKBb2RRx2ZldHUxyFxwQ\\nA70d3NUCBa7/QtyljdrIvdZj6AFKGQ/oTY84YA8PnCb3ON11PQv0dN0QgA1X\\noAuH4Fvc7SkIwABcC97hfdiIvdrgSwnOrd72QAkGDsHSnRDD57wS0g4NcAVb\\ncN1bkAKHcAh+vd95cL3+DeABPp+pjcybeAnojQMobg8JTgmqQAlSrAjSHb8q\\nOwvT0QDocOMTQAJ6UARk4M+HANr77SnY6+Egrn/tdKTjHY2LkOIqruCq8OR2\\n8MYk6ScqSyiGQAI3fuNRsOVRMAEKcAjAHeT+cARD/t8g3k5HLuJHLQMMYA/r\\nreAsbhv48QCUYD8NDnmSR+MF0At/YARGoOXoEAW8QAscMARhHNwh/1DmHm7m\\nxZ3mxw2Y1rDicY4ft/EAlp4tlS3LkndD3ODnfp7lW14EW7AHYu4pg9C6Zc5/\\njE7a+4fkad3iTy7nlW4KtC4N9hAAU47nR1IAwtAMno4Of77labQHrVDqYWC9\\nis61qx7i83kIsU7plk7rppAI1G4K0UCSDp4JbgAdJNAMvv7pOL4YViAPpe4P\\n+pvsy87qrT6ftQHtiUPr1K4M+9EC9nDnlOYDg+EDf+Dt3/7n6EALi0EL+VDu\\nD4DsqI69ql7kjo4F7r4IpiAN8T7vjdAIdmDv74DvPsAN/O7tv14EiUECUQAC\\npV4G+ovsqf7hAH6a1jDr8E7tLaAbE+8FMv//3n6S79MwBDuw7xzv6e2gGBMQ\\nBadQ6gSABQ5AAA4gAodg8kOe8GduCu8O8S7/8jHfH5/HDiWRDH6QA9hwK4PB\\nDfbyBLRAAtPxDbaw5X0g5mlwCXzsMwgABUdw8Aif7ocg7fEu9VP/eUPwCmDw\\nAzPxA+TgBxgQ+BBgMpUjKNQR6FEwB6WuDJdw6AAQuMnO9KQNI3UP8x0DQHoP\\nBmBABnuxEH4f+KAP+LitPNNRDFq+DCN/CSQt3Psb+fyXBZU/8ZevA5mv+Zqf\\nAz/AED+gBeQA+r4f+DkAAShTBKAu8kFOAOFQDQV97oqu6o0g8TFP+7Vv+5Ug\\nC9+q+1PQ+7//+1n/DwFF4O/osAFiDgB4DNT+UPDWC/lljgV23zF5b/vwXwny\\njw3f+hE/kP1TsP36/wxNABBNeEVBp87fQYQJFS5k2NBOjGoEwvxKSOASFowZ\\nscDgyHFIo0ZehrwCU9JkyUopK8nKlIkHP379+P2YMoUcBpw5deZ8RohQE6Cn\\nGg4lOnRGDKRZsoS7pMPSA6YXNWLsKJLkSZOVwKhMGSTTrJf9ZNKcomXKTrQY\\nevr02cSIvKJxi6aJkaVuXaZMs1ziO5UqPawnuXK9AWEW2Jhja9pMuzMd27YW\\nLNga10fuZYUPkdZdqpTv575YbJQbkCHw1sEpb9wQMstwWLFkbfppjJPc/wTI\\nhHhJ5r0BBGbMRzfb7ez5MwwbpTMsx5pa9eob2CBM5yETpmzGtTE8hrybN29b\\nc1oBn6trc9K7nhmUy6BcOUrn0KHLcr0FQvWYMxdnb3w7t/fvwFMiFvKG0uw8\\n4kRLYjkGG0RtMPlWc+GGdyCwbwtYrOsHu7K0a+K/AEO04K0CF8InBvPOg2GE\\nKpZTrsHSUotwwgnnmW4LHGGBKbb9bMqhsSly082CW0QMkDLLSvQHFQFiOESX\\nLGzQpkUY22swA8Lko9EFLqfBEcdvMhRrwx610OLHtJ5Rc01ahHnCzTeFkXNO\\nOfWQkwQ6NNFzTz2X0GQJQAMVdJEYsBhBAyrbK/9tgBcbrCTCG7bkkstvvvwm\\nzPzI7JEcNLXDCYICQhXVkAIMMdWQd0x1Y9VdiuHGA1hjhfWQQzyg9dZDYmBg\\nyioSVfRKFwfYZ8ZIJ3XhGhe83OLSSwEZU78ea+pUO2wK8MFaUUMl9dReDOll\\n1VXbuYIZWWOl1dZDLpGhV3YZXLTR9vZhUMJijUX2mmveYRZcQDLlsCZOp21s\\nCx+uLTjbbE/11ttv3diFkSHKRReGcthtN1hgrdxH2Awk5fJefK+ZZ9lvVvXW\\n2cT+ZSwHgdHCpmCYDb4WYVNL7baXbsN9FdYYbKDA4otddBdYeffZx9iPjw35\\nmmlKNtnUfmXSNNqAW9b/6eWYY8YWYW0V7tYQhxWAwwege61y6OXkbdDoSUFe\\nWuR3wP3akKhjUtlHlqklG+YqsjaY620VNgQDMcQQouwrX3zR6KKFZfttyKtw\\n+utQnRUL2mjLYjnvtLDpu9e9/ZYZ8FK3maLwwn8OmlF3lWNc7df3gfzteaZZ\\n+NTKx5y6RxJ69/333mvBwHOLQ/fhiR2SV34HS47hmnAafJ9gh3AaDMcB7LE/\\nIoPY441dhOzDz94VN3DPNmoeM5drAyfK7lWH34baYetVCidBIT6C5UMhB4r2\\nn3FheSANRVGCwhBmObtlbgqXyYYNyuYFAMQFCtPwQf3spxAraGBRR+Af91wX\\n/zsPoCIuCCAV13yAMsWo7zIOaJHFSHEZHZABdWK4X0JoIAENLIeDCXFA2rgX\\nuwG8MC6kKGGoZuaDTEhtd/vBTBoyYLYqeAEzFpihGCagEBqIQQJVGMAOEdLD\\n2L0uHJdBAMIOhsTELHExwLnS/i6zAQlIQItWxKIccejGL/4wjPvw4kHSQApA\\nBhKQUDCiEWE2C93dTSEW2EMjaWABhbgnA3g8SAj4cElK+kMJWoyjBK6YECtw\\nUgKZ7N8ejdZHfzjgGgNY5SpnZsisJXFHikwICTLBskzUECFtxJ/FFKKETmrx\\nkwixQiclYAX+mfKUCpnBEZzpzHpkS2Yxm0ViMNcjhf+QABs5uKUuD9KoTOaP\\nQb80picxaExk8lCZfIxLNuBhrWnurZpjoiVCbAkBbnrTH2pbTjgZVAVyGnOY\\nBylmJ9P5xXWOUS6WEB3ZqgmTazLxMk40WntQub3lbIOc7OjkQP1RUI4e9CCl\\nfJ3jjCbEogDAE6KrAiKlVs+4gJF7GUDlDLLnUWCyg6Ps8GgxdyrSVK5zH/WI\\noARjZjFEQhSmRCEFg9SGSqIoQadT7alOJcAOoJJUmeFA6VBIETqk+ssPKizK\\nDorxwx9CdShSvapOqzpVoO7ApMocgAdcIb74HeSroEOqEn8w1mgVRR0KyEEw\\nKqoctTZEquzggFsVooepskP/DwqZAAfmakpGvc4HXSXF54CWVLthALASRYhB\\nFpmDd4QxsQxRQmNd61HITnWyCVHC9MTnCsY9U7dH4AM8spGQvVrsiRB4Fg/8\\ncFxsJmQDHvUHLQyhWsy01rXs2MFj2ZGC6862KKRgHGY6K9zlEPdyP8AJcteo\\n3ClsQCHq0AF0QdkN+HbjlxygL31hO13tMrW7lwkB0BiUoR3x4EfmrYlCNjAF\\nCRAoIWmwQexQqQcyxHe+9eXAfVOQAg7k16v7jQsAHGi2Bv0gUzyQQ05Ga+Cy\\n0MBEDsZgN8gQ4QnXt7oJ0QOGOZACDTeEu0aTCwC80EKhDcAHMDGHWATMsuMC\\nFsVl/9GnP0Jg0kw24MUv/qUTOGDlCj8WETfGsVx2vI+UzsATIFZUaTIRk3QY\\n+ZYlFq0Ce5QJHBXgdU+MRCSwEYlVBCHPQZhyn7vhhD9fWdAc2DKhKXxhRCc6\\n0Yi4LOPcl6hGVUFqc4gJLGaxufKO1s2VkrOj63znOkciCKMedZ+n7ARUp1rQ\\niLAyIlyNYURcONaInrWs9ci4JyJOaFYawDzP8Q+ZwAICLckbgd08i290eh9V\\nCIadQw3qO5Oa1H1GNRlSjeorO2HLruZ2rLudAm+Dm9Gxcx/GXmSIMbnjH5W2\\nzy2RbOzM+cENBRAWs0N9b3zXWdp8pra1r61tbXdb4N/2Nv8i5gzeIJd5Gjui\\nwT+AzQ9YVGrYnNO0Agm27GBkvNnNzje+921qf/+b1QEfuMDFPe5lk/lspUG3\\nWKbQCofLBBBuwNEs3C3aikcrB2TTeM81HgmOd3zf/PZ3yFPNaqSXfODF0EDK\\nE9e6liZmCvJwOLD7AQhU2efSbG6zm7VgiG1ofBc+//nGgZ7vbYw67aVux4v/\\nfXSSK53by/HVrzIwDZTBBANUrzpMeAAIWASeB4P/AQ9+cHjEJx7xWgDE5nLQ\\neMdHXvKbg/zkMZ23H/1oFRjYPOc9v3nQ58Aw0xn9LACvO7HQAOZVf/jl0ii1\\nHcXe9bPX3euftaPL5R71tIf97nsy7/o0WlP2r4/JOU7B+r5nqva7jz1EdZ97\\n4qNe+bonfvCfVXvly1762beOOdLBd+Q7PCAAOw==\\n" }, "filename": { "type": "string", "description": "Name of file", "example": "mylogo.jpg" }, "height": { "type": "integer", "description": "Height dimension of the image which is determined on upload.", "example": 480 }, "id": { "type": "integer", "description": "A unique numeric identifier for the product image.", "example": 850703190 }, "position": { "type": "integer", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": 1 }, "product_id": { "type": "integer", "description": "The id of the product associated with the image.", "example": 632910392 }, "src": { "type": "string", "description": "Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).", "example": "https://img.btdmp.com/products/ipod-nano.png" }, "updated_at": { "type": "integer" }, "width": { "type": "integer", "description": "Width dimension of the image which is determined on upload.", "example": 640 } }, "type": "object" }, "ProductOptionSet": { "properties": { "id": { "type": "integer" }, "options": { "items": { "$ref": "#/definitions/gitlab.ProductOption" }, "type": "array" }, "position": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "ProductPatchFields": { "properties": { "add_collections": { "items": { "type": "integer" }, "type": "array" }, "add_tags": { "items": { "type": "string" }, "type": "array" }, "import_progress": { "items": { "type": "string" }, "type": "array" }, "published": { "type": "boolean" }, "remove_collections": { "items": { "type": "integer" }, "type": "array" }, "remove_tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ProductPatchRequest": { "properties": { "count_retry": { "type": "integer" }, "data": { "$ref": "#/definitions/ProductPatchFields" }, "dest_shop_id": { "type": "integer" }, "exclude_ids": { "items": { "type": "integer" }, "type": "array" }, "has_custom_option": { "type": "string" }, "has_image": { "type": "string" }, "ids": { "items": { "type": "integer" }, "type": "array" }, "keep_current_product_id": { "type": "boolean" }, "page": { "type": "integer" }, "published_status": { "type": "string" }, "shop_id": { "type": "integer" }, "title": { "type": "string" }, "title_mode": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "ProductRemoveMappingResponse": { "properties": { "success": { "type": "boolean" } }, "type": "object" }, "ProductReorderOptionItem": { "properties": { "id": { "type": "integer", "description": "Id of product option set", "example": 100 }, "values": { "items": { "type": "string" }, "type": "array", "description": "List of product option value.", "example": [ "Red", " Blue", " Green" ] } }, "type": "object" }, "ProductReorderRequest": { "properties": { "options": { "items": { "$ref": "#/definitions/ProductReorderOptionItem" }, "type": "array", "description": "List of option want to reorder" }, "product_id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 } }, "type": "object" }, "ProductStaff": { "properties": { "id": { "type": "integer" }, "role": { "type": "string" }, "staff_user_id": { "type": "integer" } }, "type": "object" }, "ProductSwaggerRequest": { "properties": { "product": { "$ref": "#/definitions/ProductDtoSwagger" } }, "type": "object" }, "ProductSwaggerResponse": { "properties": { "product": { "$ref": "#/definitions/ProductDto" } }, "type": "object" }, "ProductUpdateRequestSwagger": { "properties": { "is_create_redirect": { "type": "boolean", "description": "Option for create redirect or not when update product. If true, create a redirect from old handle to new handle", "example": true }, "product": { "$ref": "#/definitions/ProductDtoTransformRequestUpdateProduct", "description": "Data of product to update" } }, "type": "object" }, "ProductVariantAggregateResponse": { "properties": { "inventory_count": { "type": "integer" }, "inventory_policy": { "type": "string" }, "is_has_any_inventory_management": { "type": "boolean" }, "product_id": { "type": "integer" }, "variant_count": { "type": "integer" } }, "type": "object" }, "ProductVariantDtoRequest": { "properties": { "duplicate_from_variant": { "type": "boolean" }, "variant": { "$ref": "#/definitions/ProductVariantRawRequest" } }, "type": "object" }, "ProductVariantDuplicateRequest": { "properties": { "new_value": { "type": "string", "description": "Value of option want to duplicate", "example": "Pink" }, "option_id": { "type": "integer", "description": "Option set id that want to duplicate", "example": 274948 }, "variants": { "items": { "type": "integer" }, "type": "array", "description": "List of form variant ids want to duplicate", "example": [ 274942, 274948 ] } }, "type": "object" }, "ProductVariantDuplicateResponseSwagger": { "properties": { "fail": { "items": { "type": "integer" }, "type": "array", "description": "List of variant id duplicate failure", "example": [ 100013905 ] }, "status": { "type": "boolean", "description": "Status of duplicate process: true or false", "example": true }, "success": { "items": { "type": "integer" }, "type": "array", "description": "List of variant id duplicate successful", "example": [ 100013903, 100013904 ] } }, "type": "object" }, "ProductVariantRawRequest": { "properties": { "barcode": { "type": "string", "description": "The barcode, UPC, or ISBN number for the product.", "example": "1234_pink" }, "fulfillment_service": { "type": "string", "description": "The fulfillment service associated with the product variant. Valid values: manual or the handle of a fulfillment service.", "example": "manual" }, "grams": { "type": "integer", "description": "The weight of the product variant in grams.", "example": 567 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "inventory_management": { "type": "string", "description": "The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to shopify. Valid values: shopify or the handle of a fulfillment service that has inventory management enabled. Must be the same fulfillment service referenced by the fulfillment_service property.", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", "example": "continue" }, "inventory_quantity": { "type": "integer", "description": "An aggregate of inventory across all locations. To adjust inventory at a specific location, use the InventoryLevel resource.", "example": 10 }, "option1": { "type": "string", "description": "You can define three options for a product: option1, option2, option3. Default value: Default Title.", "example": "Pink" }, "option2": { "type": "string", "description": "You can define three options for a product: option1, option2, option3. Default value: Default Title.", "example": "Blue" }, "option3": { "type": "string", "description": "You can define three options for a product: option1, option2, option3. Default value: Default Title.", "example": "Red" }, "position": { "type": "integer", "description": "The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed.", "example": 1 }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService.", "example": "IPOD2008PINK" }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The title of the product variant.", "example": "Pink" }, "weight": { "type": "number", "description": "The weight of the product variant in the unit system specified with weight_unit", "example": 100 }, "weight_unit": { "type": "string", "description": "The unit of measurement that applies to the product variant's weight. If you don't specify a value for 'weight_unit', then the shop's default unit of measurement is applied. Valid values: g, kg, oz, and lb.", "example": "oz" } }, "type": "object" }, "ProductVariantRawRequestSwagger": { "properties": { "barcode": { "type": "string", "description": "The barcode, UPC, or ISBN number for the product.", "example": "1234_pink" }, "fulfillment_service": { "type": "string", "description": "The fulfillment service associated with the product variant. Valid values: manual or the handle of a fulfillment service.", "example": "manual" }, "grams": { "type": "integer", "description": "The weight of the product variant in grams.", "example": 567 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "inventory_management": { "type": "string", "description": "The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to shopify. Valid values: shopify or the handle of a fulfillment service that has inventory management enabled. Must be the same fulfillment service referenced by the fulfillment_service property.", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", "example": "continue" }, "inventory_quantity": { "type": "integer", "description": "An aggregate of inventory across all locations. To adjust inventory at a specific location, use the InventoryLevel resource.", "example": 10 }, "option1": { "type": "string", "description": "You can define three options for a product: option1, option2, option3. Default value: Default Title.", "example": "Pink" }, "option2": { "type": "string", "description": "You can define three options for a product: option1, option2, option3. Default value: Default Title.", "example": "Blue" }, "option3": { "type": "string", "description": "You can define three options for a product: option1, option2, option3. Default value: Default Title.", "example": "Red" }, "position": { "type": "integer", "description": "The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed.", "example": 1 }, "price": { "type": "string", "description": "The price of the product variant.", "example": "199.00" }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService.", "example": "IPOD2008PINK" }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The title of the product variant.", "example": "Pink" }, "weight": { "type": "number", "description": "The weight of the product variant in the unit system specified with weight_unit", "example": 100 }, "weight_unit": { "type": "string", "description": "The unit of measurement that applies to the product variant's weight. If you don't specify a value for 'weight_unit', then the shop's default unit of measurement is applied. Valid values: g, kg, oz, and lb.", "example": "oz" } }, "type": "object" }, "ProductVariantRequestWithOptionValueDto": { "properties": { "barcode": { "type": "string", "description": "The code of variant for easy managing", "example": "9 788073 400972" }, "body_html": { "type": "string" }, "compare_at_price": { "type": "number", "description": "The price compare with", "example": 200 }, "cost_per_item": { "type": "number" }, "fulfillment_service": { "type": "string", "description": "The name of fulfillment", "example": "Shop base fulfillment" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product variant. Each id is unique across the ShopBase system. No two products variant will have the same id, even if they're from different shops.", "example": 632910392 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "image_ids": { "type": "string" }, "inventory_management": { "type": "string", "description": "The name of inventory management", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock. Valid values\n* **deny**: Customers are not allowed to place orders for the product variant if it's out of stock\n* **continue**: Customers are allowed to place orders for the product variant if it's out of stock." }, "inventory_quantity": { "type": "integer", "description": "The quantity in inventory.", "example": 100 }, "is_default": { "type": "boolean", "description": "Option to decide that this variant is default or not", "example": true }, "metafields": { "items": { "$ref": "#/definitions/MetaField" }, "type": "array" }, "option1": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService", "example": "IPOD2008PINK" }, "position": { "type": "integer", "description": "The position of variant.", "example": 1 }, "price": { "type": "number", "description": "The price of variant.", "example": 100 }, "product_id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "The Metafield resource allows you to add additional information to other Admin API resources. Present, we don't use this field. We use table metafield instead.", "example": "null" }, "sync_cache_time": { "type": "integer" }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "updated_at": { "type": "integer" }, "weight": { "type": "number", "description": "Weight of product", "example": 12 }, "weight_unit": { "type": "string", "description": "unit of weight", "example": "12" } }, "type": "object" }, "ProductVariantRequestWithOptionValueDtoSwagger": { "properties": { "barcode": { "type": "string", "description": "The code of variant for easy managing", "example": "9 788073 400972" }, "compare_at_price": { "type": "number", "description": "The price compare with", "example": 200 }, "cost_per_item": { "type": "number" }, "fulfillment_service": { "type": "string", "description": "The name of fulfillment", "example": "shopbase" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product variant. Each id is unique across the ShopBase system. No two products variant will have the same id, even if they're from different shops.", "example": 632910392 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "inventory_management": { "type": "string", "description": "The name of inventory management", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock. Valid values\n\u003c/br\u003e**deny**: Customers are not allowed to place orders for the product variant if it's out of stock\n\u003c/br\u003e**continue**: Customers are allowed to place orders for the product variant if it's out of stock." }, "inventory_quantity": { "type": "integer", "description": "The quantity in inventory.", "example": 100 }, "is_default": { "type": "boolean", "description": "Option to decide that this variant is default or not", "example": true }, "option1": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService", "example": "IPOD2008PINK" }, "price": { "type": "number", "description": "The price of variant.", "example": 100 }, "product_id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "The Metafield resource allows you to add additional information to other Admin API resources. Present, we don't use this field. We use table metafield instead." }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "weight": { "type": "number", "description": "Weight of product", "example": 12 }, "weight_unit": { "type": "string", "description": "unit of weight", "example": "12" } }, "type": "object" }, "ProductVariantResponse": { "properties": { "barcode": { "type": "string", "description": "The barcode, UPC, or ISBN number for the product.", "example": "1234_pink" }, "compare_at_price": { "type": "string", "description": "The original price of the item before an adjustment or a sale.", "example": "299.00" }, "created_at": { "type": "string", "description": "Retrieve all variants for a product.", "example": "2012-08-24T14:01:47-04:00" }, "fulfillment_service": { "type": "string", "description": "The fulfillment service associated with the product variant. Valid values: manual or the handle of a fulfillment service.", "example": "manual" }, "grams": { "type": "integer", "description": "The weight of the product variant in grams.", "example": 567 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "inventory_management": { "type": "string", "description": "The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to shopify. Valid values: shopify or the handle of a fulfillment service that has inventory management enabled. Must be the same fulfillment service referenced by the fulfillment_service property.", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", "example": "continue" }, "inventory_quantity": { "type": "integer", "description": "An aggregate of inventory across all locations. To adjust inventory at a specific location, use the InventoryLevel resource.", "example": 10 }, "option1": { "type": "string", "description": "The custom properties that a shop owner uses to define product variants.", "example": "Pink" }, "option2": { "type": "string", "description": "The custom properties that a shop owner uses to define product variants.", "example": "Blue" }, "option3": { "type": "string", "description": "The custom properties that a shop owner uses to define product variants.", "example": "Red" }, "position": { "type": "integer", "description": "The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed.", "example": 1 }, "presentment_prices": { "items": { "$ref": "#/definitions/PresentmentPrice" }, "type": "array" }, "price": { "type": "string", "description": "The price of the product variant.", "example": "199.00" }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService.", "example": "IPOD2008PINK" }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The title of the product variant.", "example": "Pink" }, "update_at": { "type": "string", "description": "The date and time when the product variant was last modified. Gets returned in ISO 8601 format.", "example": "2012-08-24T14:01:47-04:00" }, "weight": { "type": "number", "description": "The weight of the product variant in the unit system specified with weight_unit", "example": 100 }, "weight_unit": { "type": "string", "description": "The unit of measurement that applies to the product variant's weight. If you don't specify a value for 'weight_unit', then the shop's default unit of measurement is applied. Valid values: g, kg, oz, and lb.", "example": "oz" } }, "type": "object" }, "ProductsByCollectionSwaggerResponse": { "properties": { "products": { "items": { "$ref": "#/definitions/gitlab.Product" }, "type": "array" }, "total": { "type": "integer", "example": 1 } }, "type": "object" }, "ProductsSwaggerResponse": { "properties": { "products": { "items": { "$ref": "#/definitions/ProductDto" }, "type": "array" } }, "type": "object" }, "QuantityRange": { "properties": { "greater_than_or_equal_to": { "type": "number", "example": 50 } }, "type": "object" }, "Redirect": { "properties": { "from_url": { "type": "string", "description": "The old path to be redirected. When the user visits this path, they will be redirected to the target.", "example": "/products.php" }, "id": { "type": "integer", "description": "The ID for the redirect.", "example": 304339089 }, "to_url": { "type": "string", "description": "The target location where the user will be redirected. When the user visits the old path specified by the `from_url` property, they will be redirected to this location. This property can be set to any path on the shop's site, or to an external URL. (maximum: 255 characters)", "example": "/products" } }, "type": "object" }, "RedirectRequestDto": { "properties": { "from_url": { "type": "string", "description": "The old path to be redirected. When the user visits this path, they will be redirected to the target.", "example": "/products/all" }, "id": { "type": "integer", "description": "The ID for the redirect.", "example": 304339089 }, "to_url": { "type": "string", "description": "The target location where the user will be redirected. When the user visits the old path specified by the `from_url` property, they will be redirected to this location. This property can be set to any path on the shop's site, or to an external URL. (maximum: 255 characters)", "example": "/products-all" } }, "type": "object" }, "RedirectSwaggerResponse": { "properties": { "redirect": { "$ref": "#/definitions/Redirect" } }, "type": "object" }, "RedirectsSwaggerResponse": { "properties": { "redirects": { "items": { "$ref": "#/definitions/Redirect" }, "type": "array" } }, "type": "object" }, "Refund": { "properties": { "created_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the refund was created." }, "id": { "type": "integer", "description": "The unique identifier for the refund.", "example": 92738740 }, "note": { "type": "string", "description": "An optional note attached to a refund.", "example": "Item was damaged during shipping" }, "order_adjustments": { "items": { "$ref": "#/definitions/RefundOrderAdjustment" }, "type": "array", "description": "A list of order adjustments attached to the refund. Order adjustments are generated to account for refunded shipping costs and differences between calculated and actual refund amounts." }, "order_id": { "type": "integer", "description": "The unique identifier for the order that the order adjustment is associated with.", "example": 171016912932 }, "processed_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in ShopBase." }, "refund_line_items": { "items": { "$ref": "#/definitions/RefundLineItem" }, "type": "array", "description": "A list of refunded line items" }, "restock": { "type": "boolean", "description": "Whether to add the line items back to the store's inventory.\n\n```\nProvide a restock_type to influence how this refund affects inventory instead\n```", "example": true }, "user_id": { "type": "integer", "description": "The unique identifier of the user who performed the refund.", "example": 238478920 } }, "type": "object" }, "RefundDto": { "properties": { "created_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the refund was created." }, "id": { "type": "integer", "description": "The unique identifier for the refund.", "example": 92738740 }, "is_dont_withdraw_from_balance_of_seller": { "type": "boolean" }, "note": { "type": "string", "description": "An optional note attached to a refund.", "example": "Item was damaged during shipping" }, "order_adjustments": { "items": { "$ref": "#/definitions/RefundOrderAdjustmentDto" }, "type": "array" }, "order_dto": { "$ref": "#/definitions/OrderDto" }, "order_id": { "type": "integer", "description": "The unique identifier for the order that the order adjustment is associated with.", "example": 171016912932 }, "payment_fee": { "type": "number" }, "processed_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in ShopBase." }, "refund_line_items": { "items": { "$ref": "#/definitions/RefundLineItemDto" }, "type": "array" }, "restock": { "type": "boolean", "description": "Whether to add the line items back to the store's inventory.\n\n```\nProvide a restock_type to influence how this refund affects inventory instead\n```", "example": true }, "shipping": { "$ref": "#/definitions/Shipping" }, "transactions": { "items": { "$ref": "#/definitions/RefundTransactionDto" }, "type": "array" }, "user_id": { "type": "integer", "description": "The unique identifier of the user who performed the refund.", "example": 238478920 } }, "type": "object" }, "RefundLineItem": { "properties": { "discount_amount": { "type": "number", "description": "The discount of the refund line item.", "example": 10.99 }, "line_item_id": { "type": "integer", "description": "The ID of the related line item in the order.", "example": 128323456 }, "quantity": { "type": "integer", "description": "The quantity of the associated line item that was returned.", "example": 2 }, "restock_type": { "type": "string", "description": "How this refund line item affects inventory levels. Valid values\n\u003c/br\u003e**no_restock**: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be returned or made available for sale again.\n\u003c/br\u003e**cancel**: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.\n\u003c/br\u003e**return**: The items were already delivered, and will be returned to the merchant. The returned quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.\n\u003c/br\u003e**legacy_restock**: The deprecated `restock` property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.", "example": "return" }, "subtotal": { "type": "number", "description": "The subtotal of the refund line item.", "example": 10.99 }, "title": { "type": "string", "description": "The title of the refund line item.", "example": "Title" }, "total_refund": { "type": "number", "description": "The total refund on the refund line item.", "example": 2.67 }, "total_tax": { "type": "number", "description": "The total tax on the refund line item.", "example": 2.67 }, "variant_title": { "type": "string", "description": "The variant title of the refund line item.", "example": "Variant title" } }, "type": "object" }, "RefundLineItemDto": { "properties": { "discount_amount": { "type": "number", "description": "The discount of the refund line item.", "example": 10.99 }, "line_item": { "$ref": "#/definitions/OrderLineItemDto" }, "line_item_id": { "type": "integer", "description": "The ID of the related line item in the order.", "example": 128323456 }, "quantity": { "type": "integer", "description": "The quantity of the associated line item that was returned.", "example": 2 }, "restock_type": { "type": "string", "description": "How this refund line item affects inventory levels. Valid values\n\u003c/br\u003e**no_restock**: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be returned or made available for sale again.\n\u003c/br\u003e**cancel**: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.\n\u003c/br\u003e**return**: The items were already delivered, and will be returned to the merchant. The returned quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.\n\u003c/br\u003e**legacy_restock**: The deprecated `restock` property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds.", "example": "return" }, "subtotal": { "type": "number", "description": "The subtotal of the refund line item.", "example": 10.99 }, "title": { "type": "string", "description": "The title of the refund line item.", "example": "Title" }, "total_refund": { "type": "number", "description": "The total refund on the refund line item.", "example": 2.67 }, "total_tax": { "type": "number", "description": "The total tax on the refund line item.", "example": 2.67 }, "variant_title": { "type": "string", "description": "The variant title of the refund line item.", "example": "Variant title" } }, "type": "object" }, "RefundOrderAdjustment": { "properties": { "amount": { "type": "number", "description": "The value of the discrepancy between the calculated refund and the actual refund. If the kind property's value is shipping_refund, then amount returns the value of shipping charges refunded to the customer.", "example": -8 }, "kind": { "type": "string", "description": "The order adjustment type. Valid values: `shipping_refund` and `refund_discrepancy`.", "example": "shipping_refund" }, "order_id": { "type": "integer", "description": "The unique identifier for the order that the order adjustment is associated with.", "example": 171016912932 }, "reason": { "type": "string", "description": "The reason for the order adjustment. To set this value, include `discrepancy_reason` when you create a refund.", "example": "Shipping refund" }, "tax_amount": { "type": "number", "description": "The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund.", "example": 0 } }, "type": "object" }, "RefundOrderAdjustmentDto": { "properties": { "amount": { "type": "number", "description": "The value of the discrepancy between the calculated refund and the actual refund. If the kind property's value is shipping_refund, then amount returns the value of shipping charges refunded to the customer.", "example": -8 }, "kind": { "type": "string", "description": "The order adjustment type. Valid values: `shipping_refund` and `refund_discrepancy`.", "example": "shipping_refund" }, "order_id": { "type": "integer", "description": "The unique identifier for the order that the order adjustment is associated with.", "example": 171016912932 }, "reason": { "type": "string", "description": "The reason for the order adjustment. To set this value, include `discrepancy_reason` when you create a refund.", "example": "Shipping refund" }, "tax_amount": { "type": "number", "description": "The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund.", "example": 0 } }, "type": "object" }, "RefundParamsDto": { "properties": { "amount": { "type": "number", "description": "Refund amount.", "example": 10 }, "order_id": { "type": "integer", "description": "OrderId to refund ( optional )", "example": 123456 }, "reason_title": { "type": "string", "description": "Refund reason.", "example": "Refunded for the order #1234567" }, "transaction_type": { "type": "string", "description": "Transaction type.", "example": "order_refund" } }, "type": "object" }, "RefundSeller": { "properties": { "amount": { "type": "number" }, "created_at": { "type": "integer" }, "id": { "type": "integer" }, "params": { "type": "string" }, "reason": { "type": "string" }, "sb_order_id": { "type": "integer" }, "shop_id": { "type": "integer" }, "updated_at": { "type": "integer" } }, "type": "object" }, "RefundSwaggerResponse": { "properties": { "refund": { "$ref": "#/definitions/RefundDto" } }, "type": "object" }, "RefundTransactionDto": { "properties": { "amount": { "type": "number", "description": "The amount of money included in the transaction. If you don't provide a value for amount, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).", "example": 10 }, "authorization": { "type": "string", "description": "The authorization code associated with the transaction.", "example": "ch_1AtJu6CktlpKSclI4zjeQb2t" }, "conversion_rate": { "type": "number", "description": "the conversion rate used in the transaction in case amount need to be converted" }, "created_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the transaction was created." }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment.", "example": "USD" }, "currency_exchange_adjustment": { "type": "string", "description": "An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties\n\u003c/br\u003e**ID**: The ID of the adjustment.\n\u003c/br\u003e**adjustment**: The difference between the amounts on the associated transaction and the parent transaction.\n\u003c/br\u003e**original_amount**: The amount of the parent transaction in the shop currency.\n\u003c/br\u003e**final_amount**: The amount of the associated transaction in the shop currency.\n\u003c/br\u003e**currency**: The shop currency." }, "error_code": { "type": "string", "description": "A standardized error code, independent of the payment provider. Valid values\n\u003c/br\u003e**incorrect_number**\n\u003c/br\u003e**invalid_number**\n\u003c/br\u003e**invalid_expiry_date**\n\u003c/br\u003e**invalid_cvc**\n\u003c/br\u003e**expired_card**\n\u003c/br\u003e**incorrect_cvc**\n\u003c/br\u003e**incorrect_zip**\n\u003c/br\u003e**incorrect_address**\n\u003c/br\u003e**card_declined**\n\u003c/br\u003e**processing_error**\n\u003c/br\u003e**call_issuer**\n\u003c/br\u003e**pick_up_card**", "example": "invalid_cvc" }, "gateway": { "type": "string", "description": "The name of the gateway the transaction was issued through. A list of gateways can be found on ShopBase's payment gateways page.", "example": "shopbase_payments" }, "id": { "type": "integer", "description": "The ID for the transaction.", "example": 999225661 }, "kind": { "type": "string", "description": "The transaction's type. Valid values\n\u003c/br\u003e**authorization**: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.\n\u003c/br\u003e**capture**: A transfer of money that was reserved during the authorization of a shop.\n\u003c/br\u003e**sale**: The authorization and capture of a payment performed in one single step.\n\u003c/br\u003e**void**: The cancellation of a pending authorization or capture.\n\u003c/br\u003e**refund**: The partial or full return of captured money to the customer.", "example": "capture" }, "message": { "type": "string", "description": "A string generated by the payment provider with additional information about why the transaction succeeded or failed.", "example": "Marked the Cash on Delivery (COD) payment as received" }, "order_id": { "type": "integer", "description": "The ID for the order that the transaction is associated with.", "example": 450789469 }, "parent_id": { "type": "integer", "description": "The ID of an associated transaction. \n * For ```capture``` transactions, the parent needs to be an ```authorization``` transaction.\n * For ```void``` transactions, the parent needs to be an ```authorization``` transaction. \n For ```refund``` transactions, the parent needs to be a ```capture``` or ```sale``` transaction." }, "payment_details": { "type": "string", "description": "Information about the credit card used for this transaction. It has the following properties\n\u003c/br\u003e**avs_result_code**: The response code from the address verification system. The code is a single letter; see this chart for the codes and their definitions.\n\u003c/br\u003e**credit_card_bin**: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.\n\u003c/br\u003e**credit_card_company**: The name of the company that issued the customer's credit card.\n\u003c/br\u003e**credit_card_number**: The customer's credit card number, with most of the leading digits redacted.\n\u003c/br\u003e**cvv_result_code**: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions." }, "processed_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed." }, "receipt": { "type": "string", "description": "Receipt" }, "source_name": { "type": "string", "description": "The origin of the transaction. This is set by ShopBase and can't be overridden. Example values: web, pos, iphone, and android.", "example": "web" }, "status": { "type": "string", "description": "The status of the transaction. Valid values: ```pending```, ```failure```, ```success```, and ```error```.", "example": "success" }, "test": { "type": "boolean", "description": "Whether the transaction is a test transaction.", "example": true }, "transaction_amount": { "type": "number", "description": "The amount of money included in the payment gateway's transaction." }, "transaction_currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the payment provider's transaction currency used for the payment." } }, "type": "object" }, "Request": { "properties": { "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the refund.", "example": "USD" }, "is_dont_withdraw_from_balance_of_seller": { "type": "boolean", "description": "Refund dont using balance's seller.", "example": true }, "mark_as_refund": { "type": "boolean", "description": "Whether mark as refund or not." }, "note": { "type": "string", "description": "An optional note attached to a refund.", "example": "wrong size" }, "notify": { "type": "boolean", "description": "Whether to send a refund notification to the customer.", "example": true }, "payment_fee": { "type": "number", "description": "payment fee amount", "example": 10 }, "payment_gateway_inactive": { "type": "boolean", "description": "Whether the payment gateway is inactive." }, "refund_line_items": { "items": { "$ref": "#/definitions/RefundLineItem" }, "type": "array", "description": "A list of line item IDs, quantities to refund, and restock instructions. Each entry has the following properties:\n * **line_item_id**: The ID of a line item to refund.\n * **quantity**: The quantity to refund.\n * **restock_type**: How this refund line item affects inventory levels. (**no_restock**, **cancel**, **return**).\n * **location_id**: The ID of the location where the items should be restocked. This is required when the value of restock_type is return or cancel. If the item is not already stocked at the location, then the item is connected to the location. An error is returned when the item is connected to a fulfillment service location and a different location is provided." }, "restock": { "type": "boolean", "description": "Whether to add the line items back to the store inventory. Use restock_type for refund line items instead.", "example": true }, "shipping": { "$ref": "#/definitions/Shipping", "description": "Specify how much shipping to refund." }, "support_refund_via_api": { "type": "boolean", "description": "Whether the payment gateway support refunding via API." }, "transactions": { "items": { "$ref": "#/definitions/Transactions" }, "type": "array", "description": "A list of transactions to process as refunds." } }, "type": "object" }, "Res": { "properties": { "shop_domains": { "items": { "$ref": "#/definitions/ShopDomain" }, "type": "array" } }, "type": "object" }, "RetrievesListRefundsSwaggerResponse": { "properties": { "refund_sellers": { "items": { "$ref": "#/definitions/RefundSeller" }, "type": "array" }, "refunds": { "items": { "$ref": "#/definitions/RefundDto" }, "type": "array" } }, "type": "object" }, "RetrievesRefundsSwaggerResponse": { "properties": { "refund": { "$ref": "#/definitions/RefundDto" } }, "type": "object" }, "ScriptTagSwaggerResponse": { "properties": { "script_tag": { "$ref": "#/definitions/ScriptTagV2" } }, "type": "object" }, "ScriptTagV2": { "properties": { "created_at": { "type": "integer", "description": "The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the script tag was created." }, "display_scope": { "type": "string", "description": "The page or pages on the online store where the script should be included. Valid values\n* **online_store**: Include the script only on the web storefront.\n* **order_status**: Include the script only on the order status page.\n* **all**: Include the script on both the web storefront and the order status page.", "example": "online_store" }, "event": { "type": "string", "description": "The DOM event that triggers the loading of the script. Valid values: `onload`.", "example": "onload" }, "id": { "type": "integer", "description": "The ID for the script tag.", "example": 596726825 }, "private_app_id": { "type": "integer", "description": "The ID for the private app.", "example": 596726826 }, "src": { "type": "string", "description": "The URL of the remote script.", "example": "https://js-aplenty.com/foo.js" }, "third_app_id": { "type": "integer", "description": "The ID for the app.", "example": 596726825 }, "updated_at": { "type": "integer", "description": "The date and time ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the script tag was last updated." } }, "type": "object" }, "ScriptTagsSwaggerResponse": { "properties": { "script_tags": { "items": { "$ref": "#/definitions/ScriptTagV2" }, "type": "array" } }, "type": "object" }, "SendInvitationRequest": { "properties": { "customer_invite": { "$ref": "#/definitions/CustomerInvite" } }, "type": "object" }, "Shipping": { "properties": { "amount": { "type": "number", "description": "Shipping amount", "example": 10 }, "full_refund": { "type": "boolean", "description": "Whether full refund or not", "example": true } }, "type": "object" }, "ShippingLinesDto": { "properties": { "carrier_identifier": { "type": "string", "description": "A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.", "example": "third_party_carrier_identifier" }, "code": { "type": "string", "description": "A reference to the combined shipping method.", "example": "weight_based_47925+weight_based_47926+weight_based_47928" }, "discounted_price": { "type": "number", "description": "The price of the shipping method after discounts.", "example": 4 }, "fulfillment_service": { "type": "string", "description": "A reference to the fulfillment service that is being requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service; null otherwise.", "example": "third_party_fulfillment_service_id" }, "price": { "type": "number", "description": "The price of this shipping method in the shop currency. Can't be negative. (sum of all shipping rates price)", "example": 4 }, "source": { "type": "string", "description": "The source of the shipping method.", "example": "canada_post" }, "tax_lines": { "items": { "$ref": "#/definitions/TaxLineDto" }, "type": "array", "description": "A list of tax line objects, each of which details a tax applicable to this shipping line." }, "title": { "type": "string", "description": "The title of the shipping method.", "example": "Small Packet International Air" } }, "type": "object" }, "ShippingMethod": { "properties": { "carrier_code": { "type": "string" }, "discount_amount": { "type": "number" }, "discounted_price": { "type": "number" }, "method_code": { "type": "string" }, "method_title": { "type": "string" }, "price": { "type": "number" }, "shipping_rates": { "items": { "$ref": "#/definitions/ShippingRate" }, "type": "array" }, "shipping_rule_id": { "type": "integer" }, "shipping_rule_type": { "type": "string" } }, "type": "object" }, "ShippingPriceRange": { "properties": { "less_than_or_equal_to": { "type": "number", "example": 10 } }, "type": "object" }, "ShippingRate": { "properties": { "cart_item_id": { "type": "integer", "description": "The line item id which this shipping rate is applied for", "example": 123213213123 }, "code": { "type": "string", "description": "A reference to the combined shipping method.", "example": "weight_based_47925+weight_based_47926+weight_based_47928" }, "id": { "type": "integer", "description": "The Shipping Rate Id", "example": 43531 }, "is_post_purchase": { "type": "boolean" }, "price": { "type": "number", "description": "The total price of this shipping rate for a variant in the order", "example": 8 }, "raw": { "$ref": "#/definitions/ShippingRateDto" }, "title": { "type": "string", "description": "The title of the shipping method.", "example": "Small Packet International Air" }, "type": { "type": "string", "description": "The Shipping Rate Type", "example": "weight_based, price_based, item_based" }, "variant_id": { "type": "integer", "description": "The variant in which this shipping rate is applied for", "example": 123213213123 } }, "type": "object" }, "ShippingRateDto": { "properties": { "item_based": { "$ref": "#/definitions/ItemBasedShippingRateDto" }, "price_based": { "$ref": "#/definitions/PriceBasedShippingRateDto" }, "profile_id": { "type": "integer" }, "weight_based": { "$ref": "#/definitions/WeightBasedShippingRateDto" } }, "type": "object" }, "ShippingTotalDto": { "properties": { "shipping_discount": { "type": "number", "description": "Caculated shipping discount", "example": 2 }, "shipping_fee": { "type": "number", "description": "Caculated shipping fee", "example": 10 }, "shipping_tax": { "type": "number", "description": "Caculated shipping tax", "example": 2 }, "total_shipping": { "type": "number", "description": "it's equal shipping_fee - shipping_discount + shipping_tax", "example": 10 } }, "type": "object" }, "ShopDomain": { "properties": { "id": { "type": "integer", "description": "A unique identifier for the domain.", "example": 10733 }, "public_domain": { "type": "string", "description": "Domain name connected", "example": "apple.com" } }, "type": "object" }, "ShopDto": { "properties": { "address1": { "type": "string", "description": "The shop's street address.", "example": "127 Altenwerth" }, "address2": { "type": "string", "description": "The the optional second line of the shop's street address.", "example": "Suite 100" }, "city": { "type": "string", "description": "The shop's city.", "example": "Hanoi" }, "country": { "type": "string", "description": "The shop's country. In most cases matches the country_code.", "example": "US" }, "country_code": { "type": "string", "description": "The two-letter country code corresponding to the shop's country.", "example": "US" }, "country_name": { "type": "string", "description": "The shop's normalized country name.", "example": "United States" }, "county_taxes": { "type": "boolean", "description": "Whether the shop is applying taxes on a per-county basis. Only applicable to shops based in the US. Valid values: true or false.", "example": true }, "created_at": { "type": "integer", "description": "The timestamp when the shop was created.", "example": 1561694636 }, "currency": { "type": "string", "description": "The three-letter code (ISO 4217 format) for the shop's default currency.", "example": "USD" }, "current_active_storefront": { "type": "integer" }, "customer_email": { "type": "string", "description": "The contact email used for communication between the shop owner and the customer.", "example": "email@shopbase.com" }, "domain": { "type": "string", "description": "The shop's onshopbase.com domain.", "example": "apple.onshopbase.com" }, "email": { "type": "string", "description": "The contact email used for communication between ShopBase and the shop owner.", "example": "steve@job.com" }, "enable": { "type": "boolean" }, "enable_multi_storefront": { "type": "boolean" }, "enable_onboarding_multi_sf": { "type": "boolean" }, "end_free_trial_at": { "type": "integer", "description": "The timestamp when the shop's free trial was ended.", "example": 1561694636 }, "iana_timezone": { "type": "string", "description": "The name of the timezone assigned by the IANA.", "example": "America/Los_Angeles" }, "id": { "type": "integer", "description": "A unique identifier for the shop.", "example": 107333978 }, "latitude": { "type": "number", "description": "The latitude of the shop's location.", "example": 45.427408 }, "longitude": { "type": "number", "description": "The longitude of the shop's location.", "example": -75.68903 }, "max_free_storefront": { "type": "integer" }, "money_format": { "type": "string", "description": "A string representing the way currency is formatted when the currency isn't specified.", "example": "$" }, "money_in_emails_format": { "type": "string", "description": "A string representing the way currency is formatted in email notifications when the currency isn't specified.", "example": "$" }, "money_with_currency_format": { "type": "string", "description": "A string representing the way currency is formatted when the currency is specified.", "example": "$ USD" }, "money_with_currency_in_emails_format": { "type": "string", "description": "A string representing the way currency is formatted in email notifications when the currency is specified.", "example": "$ USD" }, "multi_storefront": { "type": "integer" }, "name": { "type": "string", "description": "The name of the shop.", "example": "The Apple Store" }, "online_store_enable": { "type": "integer" }, "onshopbase_domain": { "type": "string", "description": "The shop's onshopbase.com domain.", "example": "apple.onshopbase.com" }, "parent_id": { "type": "integer" }, "password_enabled": { "type": "boolean", "description": "Whether the password protection page is enabled on the online storefront.", "example": true }, "phone": { "type": "string", "description": "The contact phone number for the shop.", "example": "+1 (979) 825 5365" }, "primary_domain": { "type": "string", "description": "The shop's domain.", "example": "apple.com" }, "primary_locale": { "type": "string", "description": "The shop's primary locale, as configured in the language settings of the shop's theme.", "example": "fr" }, "province": { "type": "string", "description": "The shop's normalized province or state name.", "example": "California" }, "province_code": { "type": "string", "description": "The two-letter code for the shop's province or state.", "example": "CA" }, "shop_owner": { "type": "string", "description": "The username of the shop owner.", "example": "Santa Claus" }, "source": { "type": "string" }, "storefront_fee": { "type": "number" }, "storefront_free": { "type": "boolean" }, "subscription_expired_at": { "type": "integer", "description": "The timestamp when the shop was expired.", "example": 1561694636 }, "tax_shipping": { "type": "boolean", "description": "Whether taxes are charged for shipping. Valid values: true or false.", "example": false }, "taxes_included": { "type": "boolean", "description": "Whether applicable taxes are included in product prices. Valid values: true or false.", "example": true }, "timezone": { "type": "string", "description": "The name of the timezone the shop is in.", "example": "(GMT-05:00) Eastern Time" }, "updated_at": { "type": "integer", "description": "The timestamp when the shop was last updated.", "example": 1561694636 }, "used_free_storefront": { "type": "integer" }, "weight_unit": { "type": "string", "description": "The default unit of weight measurement for the shop.", "example": "lb" }, "zip": { "type": "string", "description": "The shop's zip or postal code.", "example": "100000" } }, "type": "object" }, "SingleDraftOrderSwaggerResponse": { "properties": { "draft_order": { "$ref": "#/definitions/OrderDto" } }, "type": "object" }, "SingleFulfillmentServiceSwaggerResponse": { "properties": { "fulfillment_service": { "$ref": "#/definitions/FulfillmentService" } }, "type": "object" }, "SingleOrderTransactionSwaggerResponse": { "properties": { "transaction": { "$ref": "#/definitions/TransactionDto" } }, "type": "object" }, "SinglePageSwaggerResponse": { "properties": { "page": { "$ref": "#/definitions/Page" } }, "type": "object" }, "SmartCollectionRule": { "properties": { "column": { "type": "string" }, "condition": { "type": "string" }, "relation": { "type": "string" } }, "type": "object" }, "SubtotalRange": { "properties": { "greater_than_or_equal_to": { "type": "number", "example": 40 } }, "type": "object" }, "SuccessResponse": { "properties": { "success": { "type": "boolean", "description": "Is Refund successfully.", "example": true } }, "type": "object" }, "SwaggerDeleteResponse": { "type": "object" }, "TaxLineDto": { "properties": { "price": { "type": "number", "description": "The amount added to the order for this tax in the shop currency.", "example": 25.81 }, "rate": { "type": "number", "description": "The tax rate applied to the order to calculate the tax price.", "example": 0.13 }, "title": { "type": "string", "description": "The name of the tax.", "example": "HST" } }, "type": "object" }, "Timeline": { "properties": { "action": { "type": "string" }, "body": { "type": "string" }, "created_at": { "type": "integer" }, "entities_type": { "type": "string" }, "id": { "type": "integer" }, "position": { "type": "integer" }, "ref_id": { "type": "integer" }, "shop_id": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "ToEntitlementQuantityRatio": { "properties": { "entitled_quantity": { "type": "number" }, "prerequisite_quantity": { "type": "number" } }, "type": "object" }, "TotalsDto": { "properties": { "not_explicit_discount": { "type": "number", "description": "Not explicit discount", "example": 123 }, "shipping_discount": { "type": "number", "description": "Caculated shipping discount", "example": 2 }, "shipping_fee": { "type": "number", "description": "Caculated shipping fee", "example": 10 }, "shipping_tax": { "type": "number", "description": "Caculated shipping tax", "example": 2 }, "subtotal_price": { "type": "number", "description": "Subtotal price", "example": 123 }, "total_discounts": { "type": "number", "description": "Total discounts", "example": 1 }, "total_line_items_discount": { "type": "number", "description": "Total line item discount", "example": 123 }, "total_line_items_price": { "type": "number", "description": "Total line item price", "example": 123 }, "total_price": { "type": "number", "description": "Total price", "example": 100000 }, "total_quantity": { "type": "number", "description": "Total quantity", "example": 100 }, "total_shipping": { "type": "number", "description": "it's equal shipping_fee - shipping_discount + shipping_tax", "example": 10 }, "total_tax": { "type": "number", "description": "Total tax", "example": 123 }, "total_weight": { "type": "number", "description": "Total height", "example": 10 }, "weight_unit": { "type": "string", "description": "weight_unit", "example": "Kg" } }, "type": "object" }, "Transaction": { "properties": { "amount": { "type": "number", "description": "The amount of money included in the transaction. If you don't provide a value for amount, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).", "example": 10 }, "authorization": { "type": "string", "description": "The authorization code associated with the transaction.", "example": "ch_1AtJu6CktlpKSclI4zjeQb2t" }, "conversion_rate": { "type": "number", "description": "the conversion rate used in the transaction in case amount need to be converted" }, "created_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the transaction was created." }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment.", "example": "USD" }, "currency_exchange_adjustment": { "type": "string", "description": "An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties\n\u003c/br\u003e**ID**: The ID of the adjustment.\n\u003c/br\u003e**adjustment**: The difference between the amounts on the associated transaction and the parent transaction.\n\u003c/br\u003e**original_amount**: The amount of the parent transaction in the shop currency.\n\u003c/br\u003e**final_amount**: The amount of the associated transaction in the shop currency.\n\u003c/br\u003e**currency**: The shop currency." }, "error_code": { "type": "string", "description": "A standardized error code, independent of the payment provider. Valid values\n\u003c/br\u003e**incorrect_number**\n\u003c/br\u003e**invalid_number**\n\u003c/br\u003e**invalid_expiry_date**\n\u003c/br\u003e**invalid_cvc**\n\u003c/br\u003e**expired_card**\n\u003c/br\u003e**incorrect_cvc**\n\u003c/br\u003e**incorrect_zip**\n\u003c/br\u003e**incorrect_address**\n\u003c/br\u003e**card_declined**\n\u003c/br\u003e**processing_error**\n\u003c/br\u003e**call_issuer**\n\u003c/br\u003e**pick_up_card**", "example": "invalid_cvc" }, "gateway": { "type": "string", "description": "The name of the gateway the transaction was issued through. A list of gateways can be found on ShopBase's payment gateways page.", "example": "shopbase_payments" }, "id": { "type": "integer", "description": "The ID for the transaction.", "example": 999225661 }, "kind": { "type": "string", "description": "The transaction's type. Valid values\n\u003c/br\u003e**authorization**: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.\n\u003c/br\u003e**capture**: A transfer of money that was reserved during the authorization of a shop.\n\u003c/br\u003e**sale**: The authorization and capture of a payment performed in one single step.\n\u003c/br\u003e**void**: The cancellation of a pending authorization or capture.\n\u003c/br\u003e**refund**: The partial or full return of captured money to the customer.", "example": "capture" }, "message": { "type": "string", "description": "A string generated by the payment provider with additional information about why the transaction succeeded or failed.", "example": "Marked the Cash on Delivery (COD) payment as received" }, "order_id": { "type": "integer", "description": "The ID for the order that the transaction is associated with.", "example": 450789469 }, "parent_id": { "type": "integer", "description": "The ID of an associated transaction. \n * For ```capture``` transactions, the parent needs to be an ```authorization``` transaction.\n * For ```void``` transactions, the parent needs to be an ```authorization``` transaction. \n For ```refund``` transactions, the parent needs to be a ```capture``` or ```sale``` transaction." }, "payment_details": { "type": "string", "description": "Information about the credit card used for this transaction. It has the following properties\n\u003c/br\u003e**avs_result_code**: The response code from the address verification system. The code is a single letter; see this chart for the codes and their definitions.\n\u003c/br\u003e**credit_card_bin**: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.\n\u003c/br\u003e**credit_card_company**: The name of the company that issued the customer's credit card.\n\u003c/br\u003e**credit_card_number**: The customer's credit card number, with most of the leading digits redacted.\n\u003c/br\u003e**cvv_result_code**: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions." }, "processed_at": { "type": "integer", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed." }, "receipt": { "type": "string", "description": "Receipt" }, "source_name": { "type": "string", "description": "The origin of the transaction. This is set by ShopBase and can't be overridden. Example values: web, pos, iphone, and android.", "example": "web" }, "status": { "type": "string", "description": "The status of the transaction. Valid values: ```pending```, ```failure```, ```success```, and ```error```.", "example": "success" }, "test": { "type": "boolean", "description": "Whether the transaction is a test transaction.", "example": true }, "transaction_amount": { "type": "number", "description": "The amount of money included in the payment gateway's transaction." }, "transaction_currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the payment provider's transaction currency used for the payment." } }, "type": "object" }, "TransactionDto": { "properties": { "amount": { "type": "number", "description": "The amount of money included in the transaction. If you don't provide a value for `amount`, then it defaults to the total cost of the order (even if a previous transaction has been made towards it).", "example": 10 }, "authorization": { "type": "string", "description": "The authorization code associated with the transaction.", "example": "ch_1AtJu6CktlpKSclI4zjeQb2t" }, "conversion_rate": { "type": "number" }, "created_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the transaction was created.", "example": "2019-03-13T16:09:54-04:00" }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment.", "example": "USD" }, "currency_exchange_adjustment": { "$ref": "#/definitions/CurrencyExchangeAdjustmentDto", "description": "An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate" }, "device_id": { "type": "integer", "description": "The ID for the device.", "example": 1 }, "error_code": { "type": "ErrorCode", "description": "A standardized error code, independent of the payment provider." }, "gateway": { "type": "string", "description": "The name of the gateway the transaction was issued through.", "example": "shopbase_payments" }, "id": { "type": "integer", "description": "The ID for the transaction.", "example": 999225661 }, "kind": { "type": "string", "description": "The transaction's type. Valid values\n* **authorization**: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.\n* **capture**: A transfer of money that was reserved during the authorization of a shop.\n* **sale**: The authorization and capture of a payment performed in one single step.\n* **void**: The cancellation of a pending authorization or capture.\n* **refund**: The partial or full return of captured money to the customer.", "example": "capture" }, "location_id": { "type": "integer", "description": "The ID of the physical location where the transaction was processed.", "example": 49202758 }, "message": { "type": "string", "description": "A string generated by the payment provider with additional information about why the transaction succeeded or failed.", "example": "Marked the Cash on Delivery (COD) payment as received." }, "order_id": { "type": "integer", "description": "The ID for the order that the transaction is associated with.", "example": 450789469 }, "parent_id": { "type": "integer", "description": "The ID of an associated transaction.", "example": 584698724408 }, "payment_details": { "$ref": "#/definitions/PaymentDetailsDto", "description": "Information about the credit card used for this transaction." }, "processed_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed.", "example": "2019-05-10T11:00:00-05:00" }, "receipt": { "type": "object", "description": "A transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway the shop is using." }, "source_name": { "type": "string", "description": "The origin of the transaction. This is set by ShopBase and can't be overridden. Example values: web, pos, iphone, and android.", "example": "web" }, "status": { "type": "string", "description": "The status of the transaction. Valid values: `pending`, `failure`, `success`, and `error`", "example": "success" }, "test": { "type": "boolean", "description": "Whether the transaction is a test transaction.", "example": true }, "transaction_amount": { "type": "number", "description": "The amount of money included in the payment gateway's transaction." }, "transaction_currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the payment provider's transaction currency used for the payment." }, "updated_at": { "type": "string", "description": "The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the transaction was updated.", "example": "2019-03-13T16:09:54-04:00" } }, "type": "object" }, "Transactions": { "properties": { "amount": { "type": "number" }, "gateway": { "type": "string" }, "kind": { "type": "string" }, "parent_id": { "type": "integer" } }, "type": "object" }, "UpdateProductImageRequest": { "properties": { "alt": { "type": "string", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": "new alt tag content" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product image.", "example": 850703190 }, "position": { "type": "integer", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": 1 } }, "type": "object" }, "UpdateProductImageRequestSwagger": { "properties": { "image": { "$ref": "#/definitions/UpdateProductImageRequest" } }, "type": "object" }, "UpdateProductImageResponseSwagger": { "properties": { "images": { "$ref": "#/definitions/AllProductImagesResponse" } }, "type": "object" }, "UpdateProductImagesVariantsResponseSwagger": { "properties": { "code": { "type": "integer" }, "message": { "type": "string" } }, "type": "object" }, "UpsertPageRequestDto": { "properties": { "is_create_redirect": { "type": "boolean", "description": "Option for create redirect from old page handle to new page handle or not", "example": true }, "page": { "$ref": "#/definitions/PageRequestDto", "description": "Data update for page" } }, "type": "object" }, "UpsertRedirectRequestDto": { "properties": { "redirect": { "$ref": "#/definitions/RedirectRequestDto" } }, "type": "object" }, "UtmData": { "properties": { "utm_content": { "items": { "type": "string" }, "type": "array" }, "utm_medium": { "items": { "type": "string" }, "type": "array" }, "utm_source": { "items": { "type": "string" }, "type": "array" }, "utm_term": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "VariantByIdSwagger": { "properties": { "variant": { "$ref": "#/definitions/ProductVariantResponse" } }, "type": "object" }, "VariantCountResponse": { "properties": { "count": { "type": "integer", "description": "All variants for a product", "example": 4 } }, "type": "object" }, "Webhook": { "properties": { "address": { "type": "string", "description": "URI where the webhook subscription should send the POST request when the event occurs.", "example": "https://apple.com/uninstall" }, "created_at": { "type": "integer", "description": "Date and time when the webhook subscription was created. The API returns this value in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).", "example": 901431826 }, "fields": { "items": { "type": "string" }, "type": "array", "description": "Optional array of fields that should be included in the webhook subscription.", "example": [ "id", "updated_at" ] }, "format": { "type": "string", "description": "Format in which the webhook subscription should send the data. Valid values are `JSON` and `XML`.", "example": "json" }, "id": { "type": "integer", "description": "Unique numeric identifier for the webhook subscription.", "example": 901431826 }, "metafield_namespaces": { "items": { "type": "string" }, "type": "array", "description": "Optional array of namespaces for any metafields that should be included the webhook subscription.", "example": [ "google", "inventory" ] }, "topic": { "type": "string", "description": "Event that triggers the webhook. Valid values are: app/uninstalled, carts/create, carts/update, checkouts/create, checkouts/delete, checkouts/update, collection_listings/add, collection_listings/remove, collection_listings/update, collections/create, collections/delete, collections/update, customer_groups/create, customer_groups/delete, customer_groups/update, customers/create, customers/delete, customers/disable, customers/enable, customers/update, draft_orders/create, draft_orders/delete, draft_orders/update, fulfillment_events/create, fulfillment_events/delete, fulfillments/create, fulfillments/update, order_transactions/create, orders/cancelled, orders/create, orders/delete, orders/fulfilled, orders/paid, orders/partially_fulfilled, orders/updated, product_listings/add, product_listings/remove, product_listings/update, products/create, products/delete, products/update, refunds/create, shop/update, themes/create, themes/delete, themes/publish, themes/update, inventory_levels/connect, inventory_levels/update, inventory_levels/disconnect, inventory_items/create, inventory_items/update, inventory_items/delete, locations/create, locations/update, locations/delete, tender_transactions/create", "example": "app/uninstalled" }, "updated_at": { "type": "integer", "description": "Date and time when the webhook subscription was updated. The API returns this value in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).", "example": 901431826 } }, "type": "object" }, "WebhookSwaggerResponse": { "properties": { "webhook": { "$ref": "#/definitions/Webhook" } }, "type": "object" }, "WebhooksSwaggerResponse": { "properties": { "webhooks": { "items": { "$ref": "#/definitions/Webhook" }, "type": "array" } }, "type": "object" }, "WeightBasedShippingRateDto": { "properties": { "created_at": { "type": "integer" }, "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "number" }, "price_unit": { "type": "string" }, "shipping_zone_id": { "type": "integer" }, "shop_id": { "type": "integer" }, "updated_at": { "type": "integer" }, "weight_high": { "type": "number" }, "weight_low": { "type": "number" }, "weight_unit": { "type": "string" } }, "type": "object" }, "cancelOrderData": { "properties": { "amount": { "type": "string", "description": "The amount of money to refund", "example": "20" }, "currency": { "type": "string", "description": "The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment.", "example": "USD" }, "email": { "type": "boolean", "description": "The email notification is going to be sent to customer or not", "example": true }, "reason": { "type": "string", "description": "The reason to cancel order", "example": "customer" }, "refund": { "type": "object", "description": "The refund object. See Refund/Create the refund for more information" }, "restock": { "type": "boolean", "description": "The order is going to be restocked or not", "example": true } }, "type": "object" }, "createRefundRequestBody": { "properties": { "refund": { "$ref": "#/definitions/Request" } }, "type": "object" }, "dto.Condition": { "properties": { "relation": { "type": "string", "description": "Condition relation", "example": "equals" }, "value": { "type": "string", "description": "Condition value", "example": "Hair" } }, "type": "object" }, "dto.CustomOption": { "properties": { "active": { "type": "boolean", "description": "Check whether option is active or not", "example": true }, "default_value": { "type": "string", "description": "Prefill on storefront", "example": "default value" }, "default_value_index": { "type": "integer", "description": "Index of default value in list values", "example": 1 }, "font_family": { "type": "string", "description": "Custom font family style", "example": "arial" }, "font_path": { "type": "string", "description": "Path to font resource", "example": "https://example.com/font_path.tff" }, "help_text": { "type": "string", "description": "Custom help text", "example": "example" }, "id": { "type": "string", "description": "Custom option ID", "example": "123443" }, "label": { "type": "string", "description": "Custom label, displayed on storefront", "example": "example label" }, "layer_name": { "type": "string", "description": "Layer name" }, "name": { "type": "string", "description": "Custom name", "example": "example name" }, "placeholder": { "type": "string", "description": "Custom placeholder", "example": "example" }, "rules": { "items": { "$ref": "#/definitions/dto.Rule" }, "type": "array", "description": "This fields is in progress..." }, "type": { "type": "string", "description": "Custom type\n\u003c/br\u003e**text**: Text field type\n\u003c/br\u003e**textarea**: Text area type\n\u003c/br\u003e**file**: File type\n\u003c/br\u003e**radio**: Radio type\n\u003c/br\u003e**select**: Select type\n\u003c/br\u003e**checkbox**: Checkbox type\n\u003c/br\u003e**picture**: Picture type", "example": "text" }, "validations": { "$ref": "#/definitions/dto.CustomOptionValidations", "description": "List validations" }, "values": { "items": { "$ref": "#/definitions/dto.CustomOptionValue" }, "type": "array", "description": "List option value" } }, "type": "object" }, "dto.CustomOptionValidations": { "properties": { "allowed_characters": { "items": { "type": "string" }, "type": "array", "description": "List character is allowed\n\u003c/br\u003e**characters**: Characters\n\u003c/br\u003e**numbers**: Numbers\n\u003c/br\u003e**symbol**: Special characters\n\u003c/br\u003e**emoji**: Emoji", "example": [ "symbol" ] }, "max_length": { "type": "integer", "description": "Maximum length", "example": 50 }, "min_size": { "type": "number", "description": "Maximum size", "example": 50 }, "required": { "type": "boolean", "description": "Check whether value is required or not", "example": true } }, "type": "object" }, "dto.CustomOptionValue": { "properties": { "text": { "type": "string", "description": "Option's text, unique", "example": "Option text" }, "thumbnail": { "type": "string", "description": "Option's thumbnail if custom option is picture choice. If thumbnail is empty, picture will be displayed by url from value" }, "value": { "type": "string", "description": "Option's value", "example": "Option value" } }, "type": "object" }, "dto.ImageRequest": { "properties": { "position": { "type": "integer", "description": "Position of list image", "example": 1 }, "src": { "type": "string", "description": "url of image", "example": "https://theme.hstatic.net/1000003443/1000386436/14/partner-shopbase.jpg?v=3381" } }, "type": "object" }, "dto.ProductOption": { "properties": { "id": { "type": "integer", "description": "Id of product option set", "example": 1002 }, "name": { "type": "string", "description": "Name of product option set", "example": "color" }, "position": { "type": "integer", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": 1 }, "product_id": { "type": "integer", "description": "The id of the product associated with the image.", "example": 632910392 }, "values": { "items": { "type": "string" }, "type": "array", "description": "List of product option", "example": [ "red", " blue", " green" ] } }, "type": "object" }, "dto.ProductVariantRequestWithOptionValue": { "properties": { "barcode": { "type": "string", "description": "The code of variant for easy managing", "example": "9 788073 400972" }, "compare_at_price": { "type": "number", "description": "The price compare with", "example": 200 }, "cost_per_item": { "type": "number" }, "fulfillment_service": { "type": "string", "description": "The name of fulfillment", "example": "shopbase" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product variant. Each id is unique across the ShopBase system. No two products variant will have the same id, even if they're from different shops.", "example": 632910392 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "inventory_management": { "type": "string", "description": "The name of inventory management", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock. Valid values\n\u003c/br\u003e**deny**: Customers are not allowed to place orders for the product variant if it's out of stock\n\u003c/br\u003e**continue**: Customers are allowed to place orders for the product variant if it's out of stock." }, "inventory_quantity": { "type": "integer", "description": "The quantity in inventory.", "example": 100 }, "is_default": { "type": "boolean", "description": "Option to decide that this variant is default or not", "example": true }, "option1": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService", "example": "IPOD2008PINK" }, "price": { "type": "number", "description": "The price of variant.", "example": 100 }, "product_id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "The Metafield resource allows you to add additional information to other Admin API resources. Present, we don't use this field. We use table metafield instead." }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "weight": { "type": "number", "description": "Weight of product", "example": 12 }, "weight_unit": { "type": "string", "description": "unit of weight", "example": "12" } }, "type": "object" }, "dto.Rule": { "properties": { "conditions": { "items": { "$ref": "#/definitions/dto.Condition" }, "type": "array" }, "show_option_ids": { "items": { "type": "string" }, "type": "array", "description": "List ids will be shown", "example": [ "1123123", "3453567" ] } }, "type": "object" }, "gitlab.Condition": { "properties": { "relation": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "gitlab.CustomOption": { "properties": { "active": { "type": "boolean" }, "default_value": { "type": "string" }, "default_value_index": { "type": "integer" }, "font_family": { "type": "string" }, "font_path": { "type": "string" }, "help_text": { "type": "string" }, "id": { "type": "string" }, "label": { "type": "string" }, "layer_name": { "type": "string" }, "name": { "type": "string" }, "p_o_d_data": { "$ref": "#/definitions/PODData" }, "placeholder": { "type": "string" }, "rules": { "items": { "$ref": "#/definitions/gitlab.Rule" }, "type": "array" }, "type": { "type": "string" }, "unique": { "type": "integer" }, "validations": { "$ref": "#/definitions/gitlab.CustomOptionValidations" }, "values": { "items": { "$ref": "#/definitions/gitlab.CustomOptionValue" }, "type": "array" }, "version": { "type": "integer" } }, "type": "object" }, "gitlab.CustomOptionValidations": { "properties": { "allowed_characters": { "items": { "type": "string" }, "type": "array" }, "max_length": { "type": "integer" }, "min_size": { "type": "number" }, "required": { "type": "boolean" } }, "type": "object" }, "gitlab.CustomOptionValue": { "properties": { "text": { "type": "string" }, "thumbnail": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "gitlab.Product": { "properties": { "body_html": { "type": "string", "description": "A description of the product. Supports HTML formatting.", "example": "\u003cp\u003eIt's the small iPod with a big idea: Video.\u003cp\u003e" }, "can_preview": { "type": "boolean", "description": "This product can be previewed by personalize tool or not" }, "created_at": { "type": "integer", "description": "Created at time" }, "custom_options": { "type": "string", "description": "The schema to generate custom option form fields" }, "handle": { "type": "string", "description": "A unique human-friendly string for the product. Automatically generated from the product's `title`. Used by the Liquid templating language to refer to objects.", "example": "ipod-nano-8gb" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 }, "metafields_global_description_tag": { "type": "string", "description": "A description of the product used for SEO purposes. Generally added to the \u003cmeta name='description'\u003e tag.", "example": "It's the small iPod with a big idea: Video." }, "metafields_global_title_tag": { "type": "string", "description": "The name of the product used for SEO purposes. Generally added to the \u003cmeta name='title'\u003e tag.", "example": "IPod Nano - White, 8GB" }, "product_availability": { "type": "integer", "description": "1. Available in all channels\n2. Hide from the sitemap.txt\n3. Hide from online store listing pages (homepage, collection pages, search page,...)\n0. Hide from all channels", "example": 7 }, "product_type": { "type": "string", "description": "A categorization for the product used for filtering and searching products.", "example": "Cult Products" }, "published": { "type": "boolean", "description": "Published or not", "example": true }, "published_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel." }, "tags": { "type": "string", "description": "A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.", "example": "Emotive, Flash Memory, MP3, Music" }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "updated_at": { "type": "integer", "description": "Updated at time" }, "vendor": { "type": "string", "description": "The name of the product's vendor.", "example": "Apple" } }, "type": "object" }, "gitlab.ProductImage": { "properties": { "alt_text": { "type": "string", "description": "The text in alt property of image", "example": "ipod-nano-xin" }, "height": { "type": "integer", "description": "Height dimension of the image which is determined on upload.", "example": 480 }, "id": { "type": "integer", "description": "A unique numeric identifier for the product image.", "example": 850703190 }, "position": { "type": "integer", "description": "The order of the product image in the list. The first product image is at position 1 and is the main image for the product.", "example": 1 }, "product_id": { "type": "integer", "description": "The id of the product associated with the image.", "example": 632910392 }, "src": { "type": "string", "description": "Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).", "example": "https://img.btdmp.com/products/ipod-nano.png" }, "updated_at": { "type": "integer" }, "width": { "type": "integer", "description": "Width dimension of the image which is determined on upload.", "example": 640 } }, "type": "object" }, "gitlab.ProductOption": { "properties": { "id": { "type": "integer" }, "position": { "type": "integer" }, "value": { "type": "string" } }, "type": "object" }, "gitlab.ProductRequest": { "properties": { "body_html": { "type": "string", "description": "A description of the product. Supports HTML formatting.", "example": "\u003cp\u003eIt's the small iPod with a big idea: Video.\u003cp\u003e" }, "handle": { "type": "string", "description": "A unique human-friendly string for the product. Automatically generated from the product's `title`. Used by the Liquid templating language to refer to objects.", "example": "ipod-nano-8gb" }, "metafields_global_description_tag": { "type": "string", "description": "A description of the product used for SEO purposes. Generally added to the \u003cmeta name='description'\u003e tag.", "example": "It's the small iPod with a big idea: Video." }, "metafields_global_title_tag": { "type": "string", "description": "The name of the product used for SEO purposes. Generally added to the \u003cmeta name='title'\u003e tag.", "example": "IPod Nano - White, 8GB" }, "product_availability": { "type": "integer", "description": "1. Available in all channels\n2. Hide from the sitemap.txt\n3. Hide from online store listing pages (homepage, collection pages, search page,...)\n0. Hide from all channels", "example": 7 }, "product_type": { "type": "string", "description": "A categorization for the product used for filtering and searching products.", "example": "Cult Products" }, "published": { "type": "boolean", "description": "Published or not", "example": true }, "published_at": { "type": "integer", "description": "The date and time (ISO 8601 format) when the product was published. Can be set to null to unpublish the product from the Online Store channel." }, "tags": { "type": "string", "description": "A string of comma-separated tags that are used for filtering and search. A product can have up to 250 tags. Each tag can have up to 255 characters.", "example": "Emotive, Flash Memory, MP3, Music" }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "vendor": { "type": "string", "description": "The name of the product's vendor.", "example": "Apple" } }, "type": "object" }, "gitlab.ProductVariant": { "properties": { "barcode": { "type": "string", "description": "The barcode, UPC, or ISBN number for the product.", "example": "1234_pink" }, "fulfillment_service": { "type": "string", "description": "The fulfillment service associated with the product variant. Valid values: manual or the handle of a fulfillment service.", "example": "manual" }, "grams": { "type": "integer", "description": "The weight of the product variant in grams.", "example": 567 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "inventory_management": { "type": "string", "description": "The fulfillment service that tracks the number of items in stock for the product variant. If you track the inventory yourself using the admin, then set the value to shopify. Valid values: shopify or the handle of a fulfillment service that has inventory management enabled. Must be the same fulfillment service referenced by the fulfillment_service property.", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", "example": "continue" }, "inventory_quantity": { "type": "integer", "description": "An aggregate of inventory across all locations. To adjust inventory at a specific location, use the InventoryLevel resource.", "example": 10 }, "position": { "type": "integer", "description": "The order of the product variant in the list of product variants. The first position in the list is 1. The position of variants is indicated by the order in which they are listed.", "example": 1 }, "product_id": { "type": "integer", "description": "The unique numeric identifier for the product.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService.", "example": "IPOD2008PINK" }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The title of the product variant.", "example": "Pink" }, "weight": { "type": "number", "description": "The weight of the product variant in the unit system specified with weight_unit", "example": 100 }, "weight_unit": { "type": "string", "description": "The unit of measurement that applies to the product variant's weight. If you don't specify a value for 'weight_unit', then the shop's default unit of measurement is applied. Valid values: g, kg, oz, and lb.", "example": "oz" } }, "type": "object" }, "gitlab.ProductVariantRequestWithOptionValue": { "properties": { "barcode": { "type": "string", "description": "The code of variant for easy managing", "example": "9 788073 400972" }, "body_html": { "type": "string" }, "compare_at_price": { "type": "number", "description": "The price compare with", "example": 200 }, "cost_per_item": { "type": "number" }, "fulfillment_service": { "type": "string", "description": "The name of fulfillment", "example": "Shop base fulfillment" }, "id": { "type": "integer", "description": "A unique numeric identifier for the product variant. Each id is unique across the ShopBase system. No two products variant will have the same id, even if they're from different shops.", "example": 632910392 }, "image_id": { "type": "integer", "description": "The unique numeric identifier for a product's image. The image must be associated to the same product as the variant.", "example": 434522 }, "image_ids": { "type": "string" }, "inventory_management": { "type": "string", "description": "The name of inventory management", "example": "shopbase" }, "inventory_policy": { "type": "string", "description": "Whether customers are allowed to place an order for the product variant when it's out of stock. Valid values\n* **deny**: Customers are not allowed to place orders for the product variant if it's out of stock\n* **continue**: Customers are allowed to place orders for the product variant if it's out of stock." }, "inventory_quantity": { "type": "integer", "description": "The quantity in inventory.", "example": 100 }, "is_default": { "type": "boolean", "description": "Option to decide that this variant is default or not", "example": true }, "metafields": { "type": "string", "description": "Weight of product: kg, g, lb", "example": "kg" }, "option1": { "type": "string", "description": "A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService", "example": "IPOD2008PINK" }, "position": { "type": "integer", "description": "The position of variant.", "example": 1 }, "price": { "type": "number", "description": "The price of variant.", "example": 100 }, "product_id": { "type": "integer", "description": "A unique numeric identifier for the product. Each id is unique across the ShopBase system. No two products will have the same id, even if they're from different shops.", "example": 632910392 }, "requires_shipping": { "type": "boolean", "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", "example": true }, "sku": { "type": "string", "description": "The Metafield resource allows you to add additional information to other Admin API resources. Present, we don't use this field. We use table metafield instead.", "example": "null" }, "sync_cache_time": { "type": "integer" }, "taxable": { "type": "boolean", "description": "Whether a tax is charged when the product variant is sold.", "example": true }, "title": { "type": "string", "description": "The name of the product.", "example": "IPod Nano - 8GB" }, "updated_at": { "type": "integer" }, "weight": { "type": "number", "description": "Weight of product", "example": 12 }, "weight_unit": { "type": "string", "description": "unit of weight", "example": "12" } }, "type": "object" }, "gitlab.Rule": { "properties": { "conditions": { "items": { "$ref": "#/definitions/gitlab.Condition" }, "type": "array" }, "show_option_ids": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "gitlab.SwaggerDeleteResponse": { "type": "object" }, "handlers.ProductRequest": { "properties": { "collection_id": { "type": "integer", "description": "Filter results by product collection ID.", "example": 123456 }, "created_at_max": { "type": "string", "description": "Show products created before date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "created_at_min": { "type": "string", "description": "Show products created after date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "limit": { "type": "integer", "description": "Return up to this many results per page. (default: 50, maximum: 250).", "example": 10 }, "page": { "type": "integer", "description": "Using for pagination. (default: 1).", "example": 1 }, "published_at_min": { "type": "string", "description": "Show products published after date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "published_status": { "type": "string", "description": "Return products by their published status. (default: any), published: Show only published products. unpublished: Show only unpublished products. any: Show all products.", "example": "any" }, "since_id": { "type": "integer", "description": "Restrict results to after the specified ID.", "example": 3456789 }, "sort_order": { "type": "string", "description": "Order which is used to arranging items. (valid orders: alpha-asc, alpha-desc, created-asc, created-desc, price-asc, price-desc)", "example": "alpha-asc" }, "title": { "type": "string", "description": "Filter product by title", "example": "product" }, "updated_at_max": { "type": "string", "description": "Show products last updated before date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" }, "updated_at_min": { "type": "string", "description": "Show products last updated after date. (format: 2014-04-25T16:15:47-04:00)", "example": "2014-04-25T16:15:47-04:00" } }, "type": "object" }, "models.SwaggerDeleteResponse": { "type": "object" }, "product_image_handlers.ImageRequest": { "properties": { "attachment": { "type": "string", "description": "An extra part or extension that is or can be attached to something to perform a particular function.", "example": "R0lGODlhbgCMAPf/APbr48VySrxTO7IgKt2qmKQdJeK8lsFjROG5p/nz7Zg3\\nMNmnd7Q1MLNVS9GId71hSJMZIuzTu4UtKbeEeakhKMl8U8WYjfr18YQaIbAf\\nKKwhKdKzqpQtLebFortOOejKrOjZ1Mt7aMNpVbAqLLV7bsNqR+3WwMqEWenN\\nsZYxL/Ddy/Pm2e7ZxLlUQrIjNPXp3bU5MbhENbEtLtqhj5ZQTfHh0bMxL7Ip\\nNsNyUYkZIrZJPcqGdYIUHb5aPKkeJnoUHd2yiJkiLKYiKLRFOsyJXKVDO8up\\nosFaS+TBnK4kKti5sNaYg/z49aqYl5kqLrljUtORfMOlo/36+H4ZH8yDYq0f\\nKKFYTaU9MrY8MrZBNXwXHpgaIdGVYu/byLZNP9SaZLIyOuXCtHkpJst+Wpcm\\nLMyCa8BfP9GMb9KQdPDd1PPk1sd5VP79/L5dQZ0bI9+ymqssK9WcfIoXHdzG\\nxdWWfteib79lSr1YP86MYurQxKdcUKdMQr5ZSfPs6YEZH8uhl4oWIenMuurQ\\nttmejaqoqsqBVaAcJLlJN5kvMLlZRMNsSL5fRak0LbdQQMVvSPjw6cJnRpkf\\nKtmjhvfu5cJtT7IuOMVvWLY/M/37+o0YH9ibhtSYdObErc6HarM9NnYSGNGR\\navLi09unje3WyeO8rsVrT7tdRtK3uffu6NWeaL9pTJIjJrM4NPbx8cdyX7M7\\nPYYVHu7j4KgoNJAYIKtkV5o9MsOcldicis+RYNutfrhFOZ0hJbqinZ8bI8h5\\nUObFuOfItJsfJrJfUOfIqc+PXqQtK8RnSbA4Mcd3Tm0SGbpXQ8aqp7RLNs+s\\novHfzpVhV9iggMd1TLtbRKUdKXEQFsd4XrZRPLIgMZUeJ+jKvrAlK6AhJ65A\\nMpMpKuC3j5obIsRwS7hAN8l/YtvDvnYXHbAoLI47SIUsOMenorF4gO/m4+fH\\npo4vLZ8oKMukqp0cJbhVSMV2UuPR0bAfMLIrLrg/OcJwT8h+Vt+wn8eurLlh\\nQrIfKHQOHHQOHf///////yH5BAEAAP8ALAAAAABuAIwAAAj/AP8JHDhQXjpz\\n/PopXNiPn0OHDRMmbKhQIsOJFS1SxAhxI8SHFzVeDBnx48iNBAeeOkcxokeX\\nFRdOnAlSokaaLXNujJkxo8iYHRkKtWkzZSsaOXkAWsoUECynsHgoqEW1qtVa\\nU7Mq2Mq1K9cUW8GKTUG2rNkUHNByWMuWLdWva7t1W7UKG4S7eO/ycEhQHgaK\\nsL4VGGyocGE3br5929KuxQFFkEtIlgypsuUDmDMfWGRmUZvPoEHfGU36jgDT\\nLQSoVt3IQ2sPsL0IUNZGlZ0H0lo00jEkCytWMspdGzBgn/F9EBIWnKIQlqHB\\nhA0bQpx48Z7UAkoEcMTdUeTJJSxf/4akOTNnzqHb3GkjrUdp0gKwq77jWdod\\nO7dNKWvhRUcWT6zYQI82xB03AAQNCdTKX/xAAB10hfVCnRtbVIhIAy14oJoZ\\nAXS4XXfdQaYIeOGJRx555Z1nRnrqqUeaMtIYY8dmn7Vg2yK57TYEgAzIQGBx\\nxyXHj0A0OOTggxFKSN1iWwTTAIYanpYdMtFE4+GVIHrn3XeUmVhZeWiIMoOY\\nnVQDGiTgKALJjIssIsADt0mjjI6+AXcDgQYi2M8/7ijEwzRIFmBIL9NVV+EW\\nVzyZ4Wqj9RBABchQWeWkV3aY5ZYjjgieeKL446mnjxwAiZVpliAjZqblt19/\\n/7HCwIAFGv+X3J4s9fMckoYhphiTQTwJ5Wqn9dDDAWuMUUEFviTrS6STVlmp\\npVmKqCkOn34aB6TIBAAOJeHZAYl6ptixSCL8edGbq8HFeqBDcygEyIOCGqYk\\nkxUW4euiq7knbA/gUDHGv//ec2wFayQbaQWinOCslVhmSUq1/gCDLJXacgtJ\\nCYu4J66cjbAKoA3CxapnOgm9g+ughdK7xYX3Rinlvj2YYcYanVBBhTg2Axzw\\nG4/4k4bBzDZbKRUQP1LIsRSX6sgBZtwhzQP68ccbj7AWty4/5igEoaC9dK3r\\noVtgs4evvzKqb8wyQ0JFJzXXbDMVcQBQLTDGVmCssstKGs09oPT/jQcRoBw9\\nMamKgEOeeg/gqBtvdVZSDnHFIQgRD4RxXWhiYEOQKNn4zncHzDIzHc0ZpHdy\\nRicIQOypKDf7q3Pd96ABzSab+E1EIYIvS2o0ijA92gPZiCB1qwL+iJxL78Z7\\n2NeHQrAK2YrCZva+bcgcujFUQIEG6WigonoCdLT9tr9UbIIAMMCEkkYacvvT\\nxSgsBPKGJKBEAw4yjhx+hyn+PAJFfztyVdWOt5B3RehyimneFuwFvQxFyTSf\\n25f1zCAqSFACDXTQ3gwSoDoElI5tZyBAINqnuhJ+Kg9vOIOaVnSHT5ECHucK\\n0OMiBxJAPCdXmGseBLoBvei5rFEStB5m/yBhjFJUIw50oIMoLvCpFRAADduj\\nwxvUYMIqmvARCBiDeiwRBk+lQQTEq5qQ3CWdJSkGAlu4y9h66EBgAbF6QhSV\\nMUpQilKcQRNLwIenfpFEJebBioC0ohrQQJ8QhMIfSwhgj2YouYTYUEmGqhBe\\nFNBDH5otgmgLnRyLWMdq0GEGCMCHJjSBjzQE8pSChMLTCJBI4pXDBeuiiA1T\\nprK7PK+SUPphsIQ1wSEag5OUKIUlyiAmAowClci0YizKILUAFi+WDQEEJOmF\\nxlnMYnOVbOP0gkjBTdZRmDiwhCuywcRkmtOEpHjC1DzBABto4xqN5AcgdEXN\\nNO4Ql0+CB2xctv9LM2SSgpXhZB0t0QlT+iMUkzinQquFihD452P0gGdGAPGN\\nHKYxjbOAwBpxqU9+ApGXQgyoQDWRgASwoAMGMMAHDrnQhc5AkQPSU0NgYVF7\\nQmAWKcBnPvc5HwGcbUVxJCInEfACQXQACUhFQkqRwAIOttScv9ABO21wA8k1\\np5Z3mYXYdNqAjvLzbHDUpFCNIQoUdGAdHUhrUg2gVAOg4AXmvEAaOPEGaCCA\\nAASQxBtIYYIq5kEHAaKHVfsRGB3eNBPYxKdXGVWGUnAzdOSxgyg+MIxhoDWt\\nal3rUlXABEBeYBQIiMMm0AAKPBBAE1A4nTjWEIAzvGEFqsvDEHqEjZj/wMKw\\n1rwlVxerGkv4AxVoAOkEmXGMOKDgA8i1LFrRioSjKrWtKRVEQlXHBBSKQhLQ\\nEG3tCHCLJaSWClD0zgHO8LBqDeIYNsDGTG4ryZtak4G7lZ6G2sBSfyCAaTK7\\nAzfgQIEzoOC/yKVsZS+bWeim1BsdqEG10oCANxDgDZwIRHa3O4hbaA91nlKB\\nKA7QBhHo0VPwCFBtAdNea86CZVztKk8FUN5PjQIHxKWABihQBkHY+L/HTa5l\\nMetcAxvAG94wQAQAkA1SIIAUBvUHdkVLgBkMwrvkPSEkVtSCJ/yCAJ5gZ20l\\nwgObziITGk3xTqUHhWoxYQVdAIYINMBmO0TA/8aCwHGOBbwOAvc4pXj2RieY\\nIY69ttgfpJBEHOLQ5ArTAQ2SaPAb4lAC33XsoaxYhUx4kFVrZoKSYlYxbOzg\\nPX8kAM1d6AILOuEDDQzBBCaIwJvhjOMAU7bOmE0qdMUhhFozQhVxiMWnuiAJ\\nQTfZyahFQydWGwA1cbiZAJL0Qiht6UzoVsxetUQaJhEKZzhDBdh+A5s9AQxU\\nq3rVN241ne0sa1rXWgjbqLUd3uqPUYhCFNDAxwzm3d3vjgF/vTvAHegUaYbw\\nwMSZyAR8oX0I2BwiC2eoQQ2srYJA6IDNb2ABqr39bVYDWMfkRgIVzs1xdEOD\\nCjhQ4nXlPe9BaOLQNf+rRjQc0eg2DM8TyvZTs3mY6Xwy4xI2YLMGdIAAhTvD\\nFWzuhKhZIHGKq9riF381rDtQho53/Bjpboc1OiEJktMbtaplrbHboCOYT9rS\\nOdhopocwgiRowOw6L0MNCKCBKjwA26IW9cRTXfE4i1vAlpUEHJze8XTXehvc\\n2AQ05k3vDHaiDGNYeaPNoAzGxbwf/86EHDCd4kbsyBMySII2NH92nevg4TbI\\nA7ZVEGqiF93ocLb7nIdhgGMIoROW4Dvft2GHOqQiDoM3+YWJnT8O7yYL3fgI\\nDwK+CrFX0lwBctUxtLH55qNd5xkYxMKvDffSn/7b4L47JYQgjnW0XvZOv0L/\\nKmz/BS5sIg5QvtkavDPlO/Am+FzOBCBqgU8veEJA9LCBDRjQznIw3/lJEIBs\\n5gqhUIALN3rWR3QTh31IFwcUkAiV1QEOCH4ddw8LkAqpUH5cgAtnIGzikHgs\\nxzSW1w3+Jgc0Bz32Rw8DoA3lQA8yIAP6xwoj4H//B4BJYAOjoAZqYIDWRn0J\\nuIB1Z3fHQAGdgHeJQIEcxwwLQH5csIHEQARE4C9aRx49oAPw5ydyIHaANUPE\\nwXwtmH/6Vw5iKIb/F4DaoAGisAIroIM7WG0MR3pDd3qoJwjVQAEUAAdvEGAG\\nsHcUgITFgAtLmIFNiAtQeAInMAa+UGwiyAEW8QMc//AkgKUNx7EPkLOCLOiC\\nNiADIzCDY0iDm2cHLxCKbNiGPueDcVh02McJ/GWHjfABxyUJdigEfUiB+pAL\\ndVAHX1B+uPCERHAChSAw8QAOHMaIE6EF3MAKkjiJxlGJljgC+UcPm7iJnch8\\nDJAHoRiKaqiDBRgK01d9LDB0QFiHdmiH1YACSDCE4ziLsscIdRCIGriLhfiL\\naxAPOKAKtbARPFAFQKKMywg5XuiC9ACN0TiNOwAAAHCNL5CN2siN3QiHcYhq\\nwCAD6WiHomAJEzmO4LcGueCOG4gLf2OIAjOPOHCPEEFT/KiMzKgNLigDABmN\\nnKgL02aQB3mNCkmKB+iNCv+IBjI2Y+O4ihcZi063DcywkReYi04Yj/ewBmuA\\nAyRYEbAAAVVwkv3oj9rwgizJks4okCMwCI+ACqgwCQaJkGq4hm3IjW8YakPn\\nCWxmhzz5kxfJd3iwkUx4lL0ojw/QlAnxlG4glQYCOStplS8YkJuoCwnwCIY5\\nCYgZljRJlqTYg9WnbTq3lm3plrGojrVWixuJgRpIDB95AgLTCCRYkjeVAXw5\\nlfqXiVa5ks64QSVlmF8JljO5mAtplj4IdJE5YzpHmenYcXCwAHKJi7rIi74Y\\nD7oQms1xU71QmpQ4AOVwmvoHmAH5ABcwna3pmompmAnJmDzIcGp5m2upmxMp\\ni+f/Zg9AIJeCeJSG+ACHAH8OwWyzoJyUCIOnCYOAKQP4wATTeQElVZio8AiI\\nCZtiSZbbuHAIUAXemZu5CZ4YyQ250KAXeJ6c2YsCYIUYwWyZUADK6QoEwAfO\\nOZ8yoANSwAT4SZ37eZjXGZtjOZshoAFQ8HAHOo6TCZ5CgAfluYS4OIhPGA8C\\n4AXBtxBP+WXvWZrZ4ClhYAkdmokzgAkhKqIjqp+GaaIyGaAL+XDOEAEueqC4\\nGaNuKQTWAAQ1OpceCQktcAgcYFuHJQc+wJfhADFpsAPhcJpewAZKKgVL2qTV\\n2ZUnKptqMApJ8ADVZqVYKpkKaodwEAflaYvAuYFE4HIe/8CIEWGhchCkJ7kE\\nJQQAHGoDZcYGckqnTGqnhWmiALqYS5AEdGCAVmqgBvqiMqagquANX3qe8cCo\\njpqX1iQHsAALaWogx5FkEBMO7URCmjqnTJqfJQql2LkClpAEwNCGahABapmq\\nqqqgjAAE3uCgTFgC6tEIZVoRzCYHckBpJ+kBJoQA+xcCqrOpdeqpT/qf2JkF\\nSQAPOdiGLoqq0QqeVOCqDUp+RMBh+7atDgELX+atPJCPKOkAJmQJ7fRH54oJ\\nc7qk+amfn+qfsAkAKqB5SeAFo7CGwBCo3smWlMkMQPaqyAAJi2AaKTBpECB5\\nUdFlKJk6qoMK/McHVsSwdFqnxP9aUv3JrgRghhcbCCswqp0XmdAamTtJmXHg\\nqjWaCmqCIwJwsg/RrSvLA6R5HDIAAyJAAJ3mKQQAAwxwC4Akp8Iqog9bna+5\\nA2V4g+kUgM/HZlUwtB2rparwYzWKB/nzAG3QtBVaq1HxA5+wl8cBA1iABTCg\\nCyGgsK7Af1lrReiariTKn6ggAmTIfDfIAJuntt7pth2bjnAABHKbC74ADi13\\nByfLrQG7sp/AA8dBD4EruIILAy0ABboAA66ATMHKqcMKsZ/aCNMouWrbu2vb\\nthw7kdUgt3VgP41WsinwEPzwb7NgqzzwA3xrCMYBuKu7ujBwvTBAAOYEtrbr\\nqQkwg5z/GLmVa7GWy7EJmo7ccGB4gAxp8i3SMLoNEXnOywOf8AmwsA/aUL3V\\ni726QELJtLi3W1ICWQ7SGLm+67tCi6UeSwGb8GOFkC1L+74uAbAq+7z1Sw0F\\nwACXcAmBy8H6O7sLxb22O52k4IwD2Yk0SL69a763KWOJgAQLACnFBgl267Qy\\nV8H0+wnUgAEb3MMbrL/a+1SaWrNMSgpYqZUEPIY1qMICyMJtCQSB4wv2czjw\\nC3mla8E6nAzcEA4+jAU/HLiJG8IAbMRW6ZLgq8S8e8BOPGM4cDtSDLqboQD4\\neMV8m8VXkAV47MMeDMJP9SmLiw82oAOpicThm8IHXL6BSgEn/4AHhbAsaRLH\\nMSG/e3vBjojHWRADeowFg9DHEMO9DmADDjAK1ZCaLknAhZzGaoyl3IALXHAC\\nMry0cjwR8juwz0sN1OBs3HDJlpwFl8DLvMrJnqKpUADKIUoKD1DGpVzAZ3vI\\nWKoIxNDKr0yysRy/dKzDP3BTChADunzJlxAOygDMJkQANlAGmMCk+CDI0KiV\\nBYzGh9zEOmcDRPCEjEwlI3IACtARkmzB1JBRs9AN3KDN2mzJZQDOJRQGNmAH\\nDSuiyhCYL2jGKIzKCMxmdwCFRMDIb9xo07y8V1y/14wXVxADIA3QWRDEBF0t\\nBi0CAOwKgDkCmmjGpzy+anwPvbjIJ//gyBitvLNswRmVVewQ0iL9yyVt0PVA\\nAIsLBfVJytK4zuXQzknADIZoiIVABNEsx8vWvN/6vJRmU6vw0T4tsyWtOvxn\\nA+EABQCgpID8gqh5lQ6dxGR4yIrgi78o01MdyVY9sJ+QCd+ARlmVzT490F8N\\nMTEQ1gwQDiGwPh260i2dzJ3Yu8eAO/fw2BVwD408w7UAEv9mqyubQBe1Q/98\\nCCA9A38NMSLAf4JtAyFw2Gnd0Il9wmKotm0Q10o5j41svFQtc/M7CwmU1/ZU\\nC559CLrwC6FdLSFA2sR9pB5anw4dvlUZDyE5j/SINKBb2RRx2ZldHUxyFxwQ\\nA70d3NUCBa7/QtyljdrIvdZj6AFKGQ/oTY84YA8PnCb3ON11PQv0dN0QgA1X\\noAuH4Fvc7SkIwABcC97hfdiIvdrgSwnOrd72QAkGDsHSnRDD57wS0g4NcAVb\\ncN1bkAKHcAh+vd95cL3+DeABPp+pjcybeAnojQMobg8JTgmqQAlSrAjSHb8q\\nOwvT0QDocOMTQAJ6UARk4M+HANr77SnY6+Egrn/tdKTjHY2LkOIqruCq8OR2\\n8MYk6ScqSyiGQAI3fuNRsOVRMAEKcAjAHeT+cARD/t8g3k5HLuJHLQMMYA/r\\nreAsbhv48QCUYD8NDnmSR+MF0At/YARGoOXoEAW8QAscMARhHNwh/1DmHm7m\\nxZ3mxw2Y1rDicY4ft/EAlp4tlS3LkndD3ODnfp7lW14EW7AHYu4pg9C6Zc5/\\njE7a+4fkad3iTy7nlW4KtC4N9hAAU47nR1IAwtAMno4Of77labQHrVDqYWC9\\nis61qx7i83kIsU7plk7rppAI1G4K0UCSDp4JbgAdJNAMvv7pOL4YViAPpe4P\\n+pvsy87qrT6ftQHtiUPr1K4M+9EC9nDnlOYDg+EDf+Dt3/7n6EALi0EL+VDu\\nD4DsqI69ql7kjo4F7r4IpiAN8T7vjdAIdmDv74DvPsAN/O7tv14EiUECUQAC\\npV4G+ovsqf7hAH6a1jDr8E7tLaAbE+8FMv//3n6S79MwBDuw7xzv6e2gGBMQ\\nBadQ6gSABQ5AAA4gAodg8kOe8GduCu8O8S7/8jHfH5/HDiWRDH6QA9hwK4PB\\nDfbyBLRAAtPxDbaw5X0g5mlwCXzsMwgABUdw8Aif7ocg7fEu9VP/eUPwCmDw\\nAzPxA+TgBxgQ+BBgMpUjKNQR6FEwB6WuDJdw6AAQuMnO9KQNI3UP8x0DQHoP\\nBmBABnuxEH4f+KAP+LitPNNRDFq+DCN/CSQt3Psb+fyXBZU/8ZevA5mv+Zqf\\nAz/AED+gBeQA+r4f+DkAAShTBKAu8kFOAOFQDQV97oqu6o0g8TFP+7Vv+5Ug\\nC9+q+1PQ+7//+1n/DwFF4O/osAFiDgB4DNT+UPDWC/lljgV23zF5b/vwXwny\\njw3f+hE/kP1TsP36/wxNABBNeEVBp87fQYQJFS5k2NBOjGoEwvxKSOASFowZ\\nscDgyHFIo0ZehrwCU9JkyUopK8nKlIkHP379+P2YMoUcBpw5deZ8RohQE6Cn\\nGg4lOnRGDKRZsoS7pMPSA6YXNWLsKJLkSZOVwKhMGSTTrJf9ZNKcomXKTrQY\\nevr02cSIvKJxi6aJkaVuXaZMs1ziO5UqPawnuXK9AWEW2Jhja9pMuzMd27YW\\nLNga10fuZYUPkdZdqpTv575YbJQbkCHw1sEpb9wQMstwWLFkbfppjJPc/wTI\\nhHhJ5r0BBGbMRzfb7ez5MwwbpTMsx5pa9eob2CBM5yETpmzGtTE8hrybN29b\\nc1oBn6trc9K7nhmUy6BcOUrn0KHLcr0FQvWYMxdnb3w7t/fvwFMiFvKG0uw8\\n4kRLYjkGG0RtMPlWc+GGdyCwbwtYrOsHu7K0a+K/AEO04K0CF8InBvPOg2GE\\nKpZTrsHSUotwwgnnmW4LHGGBKbb9bMqhsSly082CW0QMkDLLSvQHFQFiOESX\\nLGzQpkUY22swA8Lko9EFLqfBEcdvMhRrwx610OLHtJ5Rc01ahHnCzTeFkXNO\\nOfWQkwQ6NNFzTz2X0GQJQAMVdJEYsBhBAyrbK/9tgBcbrCTCG7bkkstvvvwm\\nzPzI7JEcNLXDCYICQhXVkAIMMdWQd0x1Y9VdiuHGA1hjhfWQQzyg9dZDYmBg\\nyioSVfRKFwfYZ8ZIJ3XhGhe83OLSSwEZU78ea+pUO2wK8MFaUUMl9dReDOll\\n1VXbuYIZWWOl1dZDLpGhV3YZXLTR9vZhUMJijUX2mmveYRZcQDLlsCZOp21s\\nCx+uLTjbbE/11ttv3diFkSHKRReGcthtN1hgrdxH2Awk5fJefK+ZZ9lvVvXW\\n2cT+ZSwHgdHCpmCYDb4WYVNL7baXbsN9FdYYbKDA4otddBdYeffZx9iPjw35\\nmmlKNtnUfmXSNNqAW9b/6eWYY8YWYW0V7tYQhxWAwwege61y6OXkbdDoSUFe\\nWuR3wP3akKhjUtlHlqklG+YqsjaY620VNgQDMcQQouwrX3zR6KKFZfttyKtw\\n+utQnRUL2mjLYjnvtLDpu9e9/ZYZ8FK3maLwwn8OmlF3lWNc7df3gfzteaZZ\\n+NTKx5y6RxJ69/333mvBwHOLQ/fhiR2SV34HS47hmnAafJ9gh3AaDMcB7LE/\\nIoPY441dhOzDz94VN3DPNmoeM5drAyfK7lWH34baYetVCidBIT6C5UMhB4r2\\nn3FheSANRVGCwhBmObtlbgqXyYYNyuYFAMQFCtPwQf3spxAraGBRR+Af91wX\\n/zsPoCIuCCAV13yAMsWo7zIOaJHFSHEZHZABdWK4X0JoIAENLIeDCXFA2rgX\\nuwG8MC6kKGGoZuaDTEhtd/vBTBoyYLYqeAEzFpihGCagEBqIQQJVGMAOEdLD\\n2L0uHJdBAMIOhsTELHExwLnS/i6zAQlIQItWxKIccejGL/4wjPvw4kHSQApA\\nBhKQUDCiEWE2C93dTSEW2EMjaWABhbgnA3g8SAj4cElK+kMJWoyjBK6YECtw\\nUgKZ7N8ejdZHfzjgGgNY5SpnZsisJXFHikwICTLBskzUECFtxJ/FFKKETmrx\\nkwixQiclYAX+mfKUCpnBEZzpzHpkS2Yxm0ViMNcjhf+QABs5uKUuD9KoTOaP\\nQb80picxaExk8lCZfIxLNuBhrWnurZpjoiVCbAkBbnrTH2pbTjgZVAVyGnOY\\nBylmJ9P5xXWOUS6WEB3ZqgmTazLxMk40WntQub3lbIOc7OjkQP1RUI4e9CCl\\nfJ3jjCbEogDAE6KrAiKlVs+4gJF7GUDlDLLnUWCyg6Ps8GgxdyrSVK5zH/WI\\noARjZjFEQhSmRCEFg9SGSqIoQadT7alOJcAOoJJUmeFA6VBIETqk+ssPKizK\\nDorxwx9CdShSvapOqzpVoO7ApMocgAdcIb74HeSroEOqEn8w1mgVRR0KyEEw\\nKqoctTZEquzggFsVooepskP/DwqZAAfmakpGvc4HXSXF54CWVLthALASRYhB\\nFpmDd4QxsQxRQmNd61HITnWyCVHC9MTnCsY9U7dH4AM8spGQvVrsiRB4Fg/8\\ncFxsJmQDHvUHLQyhWsy01rXs2MFj2ZGC6862KKRgHGY6K9zlEPdyP8AJcteo\\n3ClsQCHq0AF0QdkN+HbjlxygL31hO13tMrW7lwkB0BiUoR3x4EfmrYlCNjAF\\nCRAoIWmwQexQqQcyxHe+9eXAfVOQAg7k16v7jQsAHGi2Bv0gUzyQQ05Ga+Cy\\n0MBEDsZgN8gQ4QnXt7oJ0QOGOZACDTeEu0aTCwC80EKhDcAHMDGHWATMsuMC\\nFsVl/9GnP0Jg0kw24MUv/qUTOGDlCj8WETfGsVx2vI+UzsATIFZUaTIRk3QY\\n+ZYlFq0Ce5QJHBXgdU+MRCSwEYlVBCHPQZhyn7vhhD9fWdAc2DKhKXxhRCc6\\n0Yi4LOPcl6hGVUFqc4gJLGaxufKO1s2VkrOj63znOkciCKMedZ+n7ARUp1rQ\\niLAyIlyNYURcONaInrWs9ci4JyJOaFYawDzP8Q+ZwAICLckbgd08i290eh9V\\nCIadQw3qO5Oa1H1GNRlSjeorO2HLruZ2rLudAm+Dm9Gxcx/GXmSIMbnjH5W2\\nzy2RbOzM+cENBRAWs0N9b3zXWdp8pra1r61tbXdb4N/2Nv8i5gzeIJd5Gjui\\nwT+AzQ9YVGrYnNO0Agm27GBkvNnNzje+921qf/+b1QEfuMDFPe5lk/lspUG3\\nWKbQCofLBBBuwNEs3C3aikcrB2TTeM81HgmOd3zf/PZ3yFPNaqSXfODF0EDK\\nE9e6liZmCvJwOLD7AQhU2efSbG6zm7VgiG1ofBc+//nGgZ7vbYw67aVux4v/\\nfXSSK53by/HVrzIwDZTBBANUrzpMeAAIWASeB4P/AQ9+cHjEJx7xWgDE5nLQ\\neMdHXvKbg/zkMZ23H/1oFRjYPOc9v3nQ58Aw0xn9LACvO7HQAOZVf/jl0ii1\\nHcXe9bPX3euftaPL5R71tIf97nsy7/o0WlP2r4/JOU7B+r5nqva7jz1EdZ97\\n4qNe+bonfvCfVXvly1762beOOdLBd+Q7PCAAOw==\\n" }, "filename": { "type": "string", "description": "Name of file.", "example": "earrings.png" } }, "type": "object" }, "swagggerCaptureChargeParams": { "properties": { "amount": { "type": "number", "description": "Charge amount.", "example": 10 }, "order_id": { "type": "integer", "description": "OrderId to refund ( optional )", "example": 123456 }, "reason_title": { "type": "string", "description": "Charge reason.", "example": "Pay the subscription bill Feb 12,2019 - Mar 12.2019" }, "transaction_type": { "type": "string", "description": "Transaction type.", "example": "PrintBase bill" } }, "type": "object" }, "swagggerCaptureFailureResponse": { "properties": { "message": { "type": "string", "description": "If un-success, response error message.", "example": "invalid charge amount" }, "success": { "type": "boolean", "description": "Is capture charge failure.", "example": false } }, "type": "object" }, "swagggerCaptureSuccessResponse": { "properties": { "success": { "type": "boolean", "description": "Is capture charge successfully.", "example": true } }, "type": "object" }, "updateCustomerAddressForm": { "properties": { "customer_address": { "type": "object" } }, "type": "object" }, "updateFulfillmentInfo": { "properties": { "notify_customer": { "type": "boolean" }, "service": { "type": "string" }, "shipment_status": { "type": "string" }, "status": { "type": "string" }, "tracking_company": { "type": "string" }, "tracking_number": { "type": "string" }, "tracking_url": { "type": "string" } }, "type": "object" }, "updateFulfillmentRequest": { "properties": { "fulfillment": { "$ref": "#/definitions/updateFulfillmentInfo" } }, "type": "object" } }, "securityDefinitions": { "APP_ACCESS_TOKEN": { "type": "apiKey", "name": "APP_ACCESS_TOKEN", "in": "header" }, "SHOP_ACCESS_TOKEN": { "type": "apiKey", "name": "SHOP_ACCESS_TOKEN", "in": "header" }, "USER_ACCESS_TOKEN": { "type": "apiKey", "name": "USER_ACCESS_TOKEN", "in": "header" } }, "tags": [ { "description": "PhubOrderApi", "name": "PhubOrderApi" }, { "description": "The Collect resource connects a product to a custom collection. \u003c/br\u003e\u003c/br\u003eCollects are meant for managing the relationship between products and custom collections. For every product in a custom collection there is a collect that tracks the ID of both the product and the custom collection. A product can be in more than one collection, and will have a collect connecting it to each collection. Unlike many ShopBase resources, collects aren't apparent to store owners. \u003c/br\u003e\u003c/br\u003eCollects are for placing products in custom collections only. Smart collections use rules to determine which products are their members", "name": "Collect" }, { "description": "The Product resource lets you update and create products in a merchant's store. You can use product variants with the Product resource to create or update different versions of the same product. You can also add or update product images. \u003c/br\u003e\u003c/br\u003eYou can add products to collections with the CustomCollection resource and the SmartCollection resource", "name": "Product" }, { "description": "A variant can be added to a Product resource to represent one version of a product with several options. The Product resource will have a variant for every possible combination of its options. Each product can have a maximum of three options and a maximum of 250 variants.", "name": "Product Variant" }, { "description": "You can query the Checkout resource to return abandoned checkouts. A checkout is considered abandoned when a customer leaves the checkout after the first page without completing their purchase", "name": "Abandoned Checkout" }, { "description": "An order is a customer's completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provide an email address or phone number, billing address and payment information. \u003c/br\u003e\u003c/br\u003eOrders can be created through the API, but no payment information will be collected, and no transaction performed. You can mark the order with any payment status", "name": "Order" }, { "description": "There are two major parts to a refund:\u003c/br\u003e- A record of money returned to the customer\u003c/br\u003e- The line items included in the refund, along with restocking instructions\u003c/br\u003e\u003c/br\u003eBefore you create a refund, use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you're refunding shipping costs. You can then use the response in the body of the request to create the actual refund.\u003c/br\u003e\u003c/br\u003eWhen you create a refund using the response from the calculate endpoint, you can set additional options, such as whether to notify the customer of the refund. You can refund less than the calculated amount for either shipping or the line items by setting a custom value for the amount property.\u003c/br\u003e\u003c/br\u003eIf a refund includes shipping costs, or if you choose to refund line items for less than their calculated amount, then an order adjustment is created automatically to account for the discrepancy in the store's financial reports.", "name": "Refund" }, { "description": "There are two major parts to a refund:\u003c/br\u003e- A record of money returned to the customer\u003c/br\u003e- The line items included in the refund, along with restocking instructions\u003c/br\u003e\u003c/br\u003eBefore you create a refund, use the calculate endpoint to generate accurate refund transactions. Specify the line items that are being refunded, their quantity and restock instructions, and whether you're refunding shipping costs. You can then use the response in the body of the request to create the actual refund.\u003c/br\u003e\u003c/br\u003eWhen you create a refund using the response from the calculate endpoint, you can set additional options, such as whether to notify the customer of the refund. You can refund less than the calculated amount for either shipping or the line items by setting a custom value for the amount property.\u003c/br\u003e\u003c/br\u003eIf a refund includes shipping costs, or if you choose to refund line items for less than their calculated amount, then an order adjustment is created automatically to account for the discrepancy in the store's financial reports.", "name": "Transaction" }, { "description": "You can use the Fulfillment resource to view, create, modify, or delete an order's fulfillment. \u003c/br\u003e\u003c/br\u003eA fulfillment represents a group of one or more items in an order", "name": "Fulfillment" }, { "description": "You can use the domain resource to view", "name": "Domain" } ], "x-tagGroups": [ { "name": "PhubOrderApi", "tags": [ "PhubOrderApi" ] }, { "name": "Customer", "tags": [ "Customer", "Customer Address" ] }, { "name": "Product", "tags": [ "Custom Collection", "Collect", "Product", "Product Image", "Product Variant", "SmartCollection" ] }, { "name": "Discount", "tags": [ "DiscountCode", "PriceRule" ] }, { "name": "Events", "tags": [ "Webhook" ] }, { "name": "Orders", "tags": [ "Order", "DraftOrder", "Transaction", "Refund", "Abandoned Checkout" ] }, { "name": "Fulfillment", "tags": [ "Fulfillment", "FulfillmentService" ] }, { "name": "Metafield", "tags": [ "Metafield" ] }, { "name": "OnlineStore", "tags": [ "Page", "Redirect", "ScriptTag" ] }, { "name": "Payment", "tags": [ "PaymentMethod", "Payment Simulator" ] }, { "name": "Shop", "tags": [ "Shop" ] }, { "name": "Domain", "tags": [ "Domain" ] } ] }