POST /dropship-provider-shipping-fields.json

application/json

Body Required

columnType string | null Required

Column type

Values are attribute or placeholder. Default value is attribute.
dropshipProviderId integer(int32) Required

Dropship provider
enabled boolean | null Required

Enabled

Default value is true.
name string | null

Name
purpose string | null

Purpose

Values are channelReference, internalReference, invoiceAmount, price, reference, serviceLevel, sku, quantity, trackingCompany, trackingNumber, or vendorExternalId.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- columnType string | null Required
  
  Column type
  
  Values are attribute or placeholder. Default value is attribute.
- createdAt string(date-time)
  
  Created at
- dropshipProviderId integer(int32) Required
  
  Dropship provider
- enabled boolean | null Required
  
  Enabled
  
  Default value is true.
- id integer(int32)
  
  Id
- name string | null
  
  Name
- purpose string | null
  
  Purpose
  
  Values are channelReference, internalReference, invoiceAmount, price, reference, serviceLevel, sku, quantity, trackingCompany, trackingNumber, or vendorExternalId.
- updatedAt string(date-time)
  
  Updated at

POST /dropship-provider-shipping-fields.json

curl \
 --request POST 'http://api.example.com/v1/dropship-provider-shipping-fields.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"columnType":"attribute","dropshipProviderId":42,"enabled":true,"name":"string","purpose":"channelReference"}'

Request examples

{
  "columnType": "attribute",
  "dropshipProviderId": 42,
  "enabled": true,
  "name": "string",
  "purpose": "channelReference"
}

Response examples (200)

{
  "columnType": "attribute",
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipProviderId": 42,
  "enabled": true,
  "id": 42,
  "name": "string",
  "purpose": "channelReference",
  "updatedAt": "2025-05-04T09:42:00Z"
}