CSV Import

POST 
https://api.goodsdelivery.io/v1/csv/import

Authorization: x-api-key

name: x-api-keytype: apiKeyscopes: brandin: header

Use this endpoint to bulk create deliveries or returns from CSV. Required a CSV file with headers:

jobType,serviceType,brandId,externalId,packagesTotalValueUsd,addons,note,scheduledDate,customerFirstName,customerLastName,customerPhone,customerEmail,pickUpName,pickUpAddress1,pickUpAddress2,pickUpCity,pickUpZipCode,pickUpState,pickUpCountry,pickUpNote,dropOffName,dropOffAddress1,dropOffAddress2,dropOffCity,dropOffZipCode,dropOffState,dropOffCountry,dropOffNote

Some headers are optional - the same as rules as in CreateDelivery/CreateReturn endpoints apply.

Request

text/csv

Body

required

• string

Responses

200

Response with created IDs and list of errors

application/json

Schema

Schema

rows object[]required
Array [
success booleanrequired
rowNumber integerrequired
createdId string
createdShortId string
errors string[]
]

Example (from schema)

{
  "rows": [
    {
      "success": true,
      "rowNumber": 0,
      "createdId": "string",
      "createdShortId": "string",
      "errors": [
        "string"
      ]
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired

Human readable error message.

code stringrequired

Machine readable error message.

more url

More help on the error here.

Example (from schema)

{
  "message": "string",
  "code": "string",
  "more": "string"
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://api.goodsdelivery.io/v1/csv/import' \
-H 'Content-Type: text/csv' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>' \
--data-raw ''

Request Collapse all

Base URL

https://api.goodsdelivery.io/v1

Auth

Security Scheme

APIKeyHeaderAuthorizationHeader

APIKeyHeader

Body required

ResponseClear

Click the Send API Request button above and see the response here!