7ac734ca21
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
676 lines
23 KiB
YAML
676 lines
23 KiB
YAML
get:
|
|
operationId: GetShippingProfiles
|
|
summary: List Shipping Profiles
|
|
description: >-
|
|
Retrieve a list of shipping profiles. The shipping profiles can be filtered
|
|
by fields such as `id`. The shipping profiles can also be sorted or
|
|
paginated.
|
|
x-authenticated: true
|
|
parameters:
|
|
- name: fields
|
|
in: query
|
|
description: >-
|
|
Comma-separated fields that should be included in the returned data. if
|
|
a field is prefixed with `+` it will be added to the default fields,
|
|
using `-` will remove it from the default fields. without prefix it will
|
|
replace the entire default fields.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
title: fields
|
|
description: >-
|
|
Comma-separated fields that should be included in the returned data.
|
|
if a field is prefixed with `+` it will be added to the default
|
|
fields, using `-` will remove it from the default fields. without
|
|
prefix it will replace the entire default fields.
|
|
externalDocs:
|
|
url: '#select-fields-and-relations'
|
|
- name: offset
|
|
in: query
|
|
description: The number of items to skip when retrieving a list.
|
|
required: false
|
|
schema:
|
|
type: number
|
|
title: offset
|
|
description: The number of items to skip when retrieving a list.
|
|
externalDocs:
|
|
url: '#pagination'
|
|
- name: limit
|
|
in: query
|
|
description: Limit the number of items returned in the list.
|
|
required: false
|
|
schema:
|
|
type: number
|
|
title: limit
|
|
description: Limit the number of items returned in the list.
|
|
externalDocs:
|
|
url: '#pagination'
|
|
- name: order
|
|
in: query
|
|
description: >-
|
|
The field to sort the data by. By default, the sort order is ascending.
|
|
To change the order to descending, prefix the field name with `-`.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
title: order
|
|
description: >-
|
|
The field to sort the data by. By default, the sort order is
|
|
ascending. To change the order to descending, prefix the field name
|
|
with `-`.
|
|
- name: id
|
|
in: query
|
|
required: false
|
|
schema:
|
|
oneOf:
|
|
- type: string
|
|
title: id
|
|
description: Filter by a shipping profile's ID.
|
|
- type: array
|
|
description: Filter by shipping profile IDs.
|
|
items:
|
|
type: string
|
|
title: id
|
|
description: A shipping profile ID.
|
|
- name: q
|
|
in: query
|
|
description: Search term to filter the shipping profile's searchable properties.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
title: q
|
|
description: Search term to filter the shipping profile's searchable properties.
|
|
- name: type
|
|
in: query
|
|
description: Filter by a shipping profile's type.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
title: type
|
|
description: Filter by a shipping profile's type.
|
|
- name: name
|
|
in: query
|
|
description: Filter by a shipping profile's name.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
title: name
|
|
description: Filter by a shipping profile's name.
|
|
- name: created_at
|
|
in: query
|
|
description: Filter by a shipping profile's creation date.
|
|
required: false
|
|
schema:
|
|
type: object
|
|
description: Filter by a shipping profile's creation date.
|
|
properties:
|
|
$and:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an AND condition. Each object's content
|
|
is the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $and
|
|
$or:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an OR condition. Each object's content
|
|
is the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $or
|
|
$eq:
|
|
oneOf:
|
|
- type: string
|
|
title: $eq
|
|
description: Filter by an exact match.
|
|
- type: array
|
|
description: Filter by an exact match.
|
|
items:
|
|
type: string
|
|
title: $eq
|
|
description: Filter by an exact match.
|
|
$ne:
|
|
type: string
|
|
title: $ne
|
|
description: Filter by values not equal to this parameter.
|
|
$in:
|
|
type: array
|
|
description: Filter by values in this array.
|
|
items:
|
|
type: string
|
|
title: $in
|
|
description: Filter by values in this array.
|
|
$nin:
|
|
type: array
|
|
description: Filter by values not in this array.
|
|
items:
|
|
type: string
|
|
title: $nin
|
|
description: Filter by values not in this array.
|
|
$not:
|
|
oneOf:
|
|
- type: string
|
|
title: $not
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
- type: object
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
- type: array
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
items:
|
|
type: string
|
|
title: $not
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
$gt:
|
|
type: string
|
|
title: $gt
|
|
description: >-
|
|
Filter by values greater than this parameter. Useful for numbers
|
|
and dates only.
|
|
$gte:
|
|
type: string
|
|
title: $gte
|
|
description: >-
|
|
Filter by values greater than or equal to this parameter. Useful
|
|
for numbers and dates only.
|
|
$lt:
|
|
type: string
|
|
title: $lt
|
|
description: >-
|
|
Filter by values less than this parameter. Useful for numbers and
|
|
dates only.
|
|
$lte:
|
|
type: string
|
|
title: $lte
|
|
description: >-
|
|
Filter by values less than or equal to this parameter. Useful for
|
|
numbers and dates only.
|
|
$like:
|
|
type: string
|
|
title: $like
|
|
description: Apply a `like` filter. Useful for strings only.
|
|
$re:
|
|
type: string
|
|
title: $re
|
|
description: Apply a regex filter. Useful for strings only.
|
|
$ilike:
|
|
type: string
|
|
title: $ilike
|
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
|
$fulltext:
|
|
type: string
|
|
title: $fulltext
|
|
description: Filter to apply on full-text properties.
|
|
$overlap:
|
|
type: array
|
|
description: Filter arrays that have overlapping values with this parameter.
|
|
items:
|
|
type: string
|
|
title: $overlap
|
|
description: Filter arrays that have overlapping values with this parameter.
|
|
$contains:
|
|
type: array
|
|
description: Filter arrays that contain some of the values of this parameter.
|
|
items:
|
|
type: string
|
|
title: $contains
|
|
description: Filter arrays that contain some of the values of this parameter.
|
|
$contained:
|
|
type: array
|
|
description: Filter arrays that contain all values of this parameter.
|
|
items:
|
|
type: string
|
|
title: $contained
|
|
description: Filter arrays that contain all values of this parameter.
|
|
$exists:
|
|
type: boolean
|
|
title: $exists
|
|
description: Filter by whether a value for this parameter exists (not `null`).
|
|
- name: updated_at
|
|
in: query
|
|
description: Filter by a shipping profile's update date.
|
|
required: false
|
|
schema:
|
|
type: object
|
|
description: Filter by a shipping profile's update date.
|
|
properties:
|
|
$and:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an AND condition. Each object's content
|
|
is the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $and
|
|
$or:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an OR condition. Each object's content
|
|
is the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $or
|
|
$eq:
|
|
oneOf:
|
|
- type: string
|
|
title: $eq
|
|
description: Filter by an exact match.
|
|
- type: array
|
|
description: Filter by an exact match.
|
|
items:
|
|
type: string
|
|
title: $eq
|
|
description: Filter by an exact match.
|
|
$ne:
|
|
type: string
|
|
title: $ne
|
|
description: Filter by values not equal to this parameter.
|
|
$in:
|
|
type: array
|
|
description: Filter by values in this array.
|
|
items:
|
|
type: string
|
|
title: $in
|
|
description: Filter by values in this array.
|
|
$nin:
|
|
type: array
|
|
description: Filter by values not in this array.
|
|
items:
|
|
type: string
|
|
title: $nin
|
|
description: Filter by values not in this array.
|
|
$not:
|
|
oneOf:
|
|
- type: string
|
|
title: $not
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
- type: object
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
- type: array
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
items:
|
|
type: string
|
|
title: $not
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
$gt:
|
|
type: string
|
|
title: $gt
|
|
description: >-
|
|
Filter by values greater than this parameter. Useful for numbers
|
|
and dates only.
|
|
$gte:
|
|
type: string
|
|
title: $gte
|
|
description: >-
|
|
Filter by values greater than or equal to this parameter. Useful
|
|
for numbers and dates only.
|
|
$lt:
|
|
type: string
|
|
title: $lt
|
|
description: >-
|
|
Filter by values less than this parameter. Useful for numbers and
|
|
dates only.
|
|
$lte:
|
|
type: string
|
|
title: $lte
|
|
description: >-
|
|
Filter by values less than or equal to this parameter. Useful for
|
|
numbers and dates only.
|
|
$like:
|
|
type: string
|
|
title: $like
|
|
description: Apply a `like` filter. Useful for strings only.
|
|
$re:
|
|
type: string
|
|
title: $re
|
|
description: Apply a regex filter. Useful for strings only.
|
|
$ilike:
|
|
type: string
|
|
title: $ilike
|
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
|
$fulltext:
|
|
type: string
|
|
title: $fulltext
|
|
description: Filter to apply on full-text properties.
|
|
$overlap:
|
|
type: array
|
|
description: Filter arrays that have overlapping values with this parameter.
|
|
items:
|
|
type: string
|
|
title: $overlap
|
|
description: Filter arrays that have overlapping values with this parameter.
|
|
$contains:
|
|
type: array
|
|
description: Filter arrays that contain some of the values of this parameter.
|
|
items:
|
|
type: string
|
|
title: $contains
|
|
description: Filter arrays that contain some of the values of this parameter.
|
|
$contained:
|
|
type: array
|
|
description: Filter arrays that contain all values of this parameter.
|
|
items:
|
|
type: string
|
|
title: $contained
|
|
description: Filter arrays that contain all values of this parameter.
|
|
$exists:
|
|
type: boolean
|
|
title: $exists
|
|
description: Filter by whether a value for this parameter exists (not `null`).
|
|
- name: deleted_at
|
|
in: query
|
|
description: Filter by a shipping profile's deletion date.
|
|
required: false
|
|
schema:
|
|
type: object
|
|
description: Filter by a shipping profile's deletion date.
|
|
properties:
|
|
$and:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an AND condition. Each object's content
|
|
is the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $and
|
|
$or:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an OR condition. Each object's content
|
|
is the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $or
|
|
$eq:
|
|
oneOf:
|
|
- type: string
|
|
title: $eq
|
|
description: Filter by an exact match.
|
|
- type: array
|
|
description: Filter by an exact match.
|
|
items:
|
|
type: string
|
|
title: $eq
|
|
description: Filter by an exact match.
|
|
$ne:
|
|
type: string
|
|
title: $ne
|
|
description: Filter by values not equal to this parameter.
|
|
$in:
|
|
type: array
|
|
description: Filter by values in this array.
|
|
items:
|
|
type: string
|
|
title: $in
|
|
description: Filter by values in this array.
|
|
$nin:
|
|
type: array
|
|
description: Filter by values not in this array.
|
|
items:
|
|
type: string
|
|
title: $nin
|
|
description: Filter by values not in this array.
|
|
$not:
|
|
oneOf:
|
|
- type: string
|
|
title: $not
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
- type: object
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
- type: array
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
items:
|
|
type: string
|
|
title: $not
|
|
description: >-
|
|
Filter by values not matching the conditions in this
|
|
parameter.
|
|
$gt:
|
|
type: string
|
|
title: $gt
|
|
description: >-
|
|
Filter by values greater than this parameter. Useful for numbers
|
|
and dates only.
|
|
$gte:
|
|
type: string
|
|
title: $gte
|
|
description: >-
|
|
Filter by values greater than or equal to this parameter. Useful
|
|
for numbers and dates only.
|
|
$lt:
|
|
type: string
|
|
title: $lt
|
|
description: >-
|
|
Filter by values less than this parameter. Useful for numbers and
|
|
dates only.
|
|
$lte:
|
|
type: string
|
|
title: $lte
|
|
description: >-
|
|
Filter by values less than or equal to this parameter. Useful for
|
|
numbers and dates only.
|
|
$like:
|
|
type: string
|
|
title: $like
|
|
description: Apply a `like` filter. Useful for strings only.
|
|
$re:
|
|
type: string
|
|
title: $re
|
|
description: Apply a regex filter. Useful for strings only.
|
|
$ilike:
|
|
type: string
|
|
title: $ilike
|
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
|
$fulltext:
|
|
type: string
|
|
title: $fulltext
|
|
description: Filter to apply on full-text properties.
|
|
$overlap:
|
|
type: array
|
|
description: Filter arrays that have overlapping values with this parameter.
|
|
items:
|
|
type: string
|
|
title: $overlap
|
|
description: Filter arrays that have overlapping values with this parameter.
|
|
$contains:
|
|
type: array
|
|
description: Filter arrays that contain some of the values of this parameter.
|
|
items:
|
|
type: string
|
|
title: $contains
|
|
description: Filter arrays that contain some of the values of this parameter.
|
|
$contained:
|
|
type: array
|
|
description: Filter arrays that contain all values of this parameter.
|
|
items:
|
|
type: string
|
|
title: $contained
|
|
description: Filter arrays that contain all values of this parameter.
|
|
$exists:
|
|
type: boolean
|
|
title: $exists
|
|
description: Filter by whether a value for this parameter exists (not `null`).
|
|
- name: $and
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an AND condition. Each object's content is
|
|
the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $and
|
|
- name: $or
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: array
|
|
description: >-
|
|
Join query parameters with an OR condition. Each object's content is
|
|
the same type as the expected query parameters.
|
|
items:
|
|
type: object
|
|
title: $or
|
|
- name: with_deleted
|
|
in: query
|
|
description: Whether to include deleted records in the result.
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
title: with_deleted
|
|
description: Whether to include deleted records in the result.
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
- jwt_token: []
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS SDK
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_shipping-profiles/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_shipping-profiles/get.sh
|
|
tags:
|
|
- Shipping Profiles
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- type: object
|
|
description: The paginated list of shipping profiles.
|
|
required:
|
|
- limit
|
|
- offset
|
|
- count
|
|
properties:
|
|
limit:
|
|
type: number
|
|
title: limit
|
|
description: The maximum number of items returned.
|
|
offset:
|
|
type: number
|
|
title: offset
|
|
description: >-
|
|
The number of items skipped before retrieving the returned
|
|
items.
|
|
count:
|
|
type: number
|
|
title: count
|
|
description: The total number of items.
|
|
- type: object
|
|
description: The paginated list of shipping profiles.
|
|
required:
|
|
- shipping_profiles
|
|
properties:
|
|
shipping_profiles:
|
|
type: array
|
|
description: The list of shipping profiles.
|
|
items:
|
|
$ref: ../components/schemas/AdminShippingProfile.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.yaml
|
|
post:
|
|
operationId: PostShippingProfiles
|
|
summary: Create Shipping Profile
|
|
description: Create a shipping profile.
|
|
x-authenticated: true
|
|
parameters:
|
|
- name: fields
|
|
in: query
|
|
description: >-
|
|
Comma-separated fields that should be included in the returned data. if
|
|
a field is prefixed with `+` it will be added to the default fields,
|
|
using `-` will remove it from the default fields. without prefix it will
|
|
replace the entire default fields.
|
|
required: false
|
|
schema:
|
|
type: string
|
|
title: fields
|
|
description: >-
|
|
Comma-separated fields that should be included in the returned data.
|
|
if a field is prefixed with `+` it will be added to the default
|
|
fields, using `-` will remove it from the default fields. without
|
|
prefix it will replace the entire default fields.
|
|
externalDocs:
|
|
url: '#select-fields-and-relations'
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
- jwt_token: []
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminCreateShippingProfile.yaml
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS SDK
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_shipping-profiles/post.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_shipping-profiles/post.sh
|
|
tags:
|
|
- Shipping Profiles
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminShippingProfileResponse.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.yaml
|
|
x-workflow: createShippingProfilesWorkflow
|
|
x-events: []
|